WTelegramClient This event will be called when unsollicited updates/messages are sent by Telegram servers Make your handler , or return or
See Examples/Program_ReactorError.cs for how to use this
or Examples/Program_ListenUpdate.cs using the UpdateManager class instead This event is called for other types of notifications (login states, reactor errors, ...) Use this handler to intercept Updates that resulted from your own API calls Used to create a TcpClient connected to the given address/port, or throw an exception on failure Url for using a MTProxy. https://t.me/proxy?server=... Telegram configuration, obtained at connection time Number of automatic reconnections on connection/reactor failure Number of attempts in case of wrong verification_code or password Number of seconds under which an error 420 FLOOD_WAIT_X will not be raised and your request will instead be auto-retried after the delay Number of seconds between each keep-alive ping. Increase this if you have a slow connection or you're debugging your code Size of chunks when uploading/downloading files. Reduce this if you don't have much memory Is this Client instance the main or a secondary DC session Has this Client established connection been disconnected? ID of the current logged-in user or 0 Info about the current logged-in user. This is only filled after a successful (re)login, not updated later Welcome to WTelegramClient! 🙂 Config callback, is queried for: api_id, api_hash, session_pathname if specified, must support initial Length & Read() of a session, then calls to Write() the updated session. Other calls can be ignored Default config values, used if your Config callback returns Load a specific Telegram server public key A string starting with -----BEGIN RSA PUBLIC KEY----- Builds a structure that is used to validate a 2FA password Password validation configuration. You can obtain this via Account_GetPassword or through OnOther as part of the login process The password to validate Enable connecting to Telegram via on-demand HTTP requests instead of permanent TCP connection HttpClient to use. Leave for a default one Default HttpWait parameters for requests.⚠️ Telegram servers don't support this correctly at the moment.So leave for the default 25 seconds long poll Disconnect from Telegram (shouldn't be needed in normal usage) Forget about logged-in user Disconnect secondary sessions with other DCs Disconnect from Telegram (shouldn't be needed in normal usage) Forget about logged-in user Disconnect secondary sessions with other DCs Obtain/create a Client for a secondary session on a specific Data Center ID of the Data Center (use negative values for media_only) Connect immediately Client connected to the selected DC Establish connection to Telegram servers without negociating a user session Attempt to resume session immediately without issuing Layer/InitConnection/GetConfig (not recommended by default) Usually you shouldn't need to call this method: Use LoginUserIfNeeded instead.
Config callback is queried for: server_address Most methods of this class are async (Task), so please use Login as a user with given phone number (or resume previous session)
Call this method again to provide additional requested login information First call should be with phone number
Further calls should be with the requested configuration value Configuration item requested to continue login, or when login is successful
Possible values: verification_code, name (signup), password (2FA), email & email_verification_code (email registration) Login as a bot (if not already logged-in). bot token, or if token is provided by Config callback Config callback may be queried for: bot_token
Bots can only call API methods marked with [bots: ✓] in their documentation. Detail about the logged-in bot Login as a user (if not already logged-in).
(this method calls ConnectAsync if necessary) Config callback is queried for: phone_number, verification_code
and eventually first_name, last_name (signup required), password (2FA auth), email & email_verification_code (email registration), user_id (alt validation) (optional) Preference for verification_code sending Proceed to logout and login if active user session cannot be resumed successfully Detail about the logged-in user
Most methods of this class are async (Task), so please use to get the result Login via QR code Callback to display the login url as QR code to the user (QRCoder library can help you) (optional) To prevent logging as these user ids If session is already connected to a user, this method will first log out.
You can also check property before calling this method. If you need to abort the method before login is completed Detail about the logged-in user [Not recommended] You can use this if you have already obtained a login authorization manually if this was not a successful Auth_Authorization, an exception is thrown the User that was authorized This approach is not recommended because you likely didn't properly handle all aspects of the login process
(transient failures, unnecessary login, 2FA, sign-up required, slowness to respond, verification code resending, encryption key safety, etc..)
Methods LoginUserIfNeeded and LoginBotIfNeeded handle these automatically for you Long poll on HTTP connections Parameters for the long poll. Leave for the default 25 seconds. ⚠️ Telegram servers don't seem to support other parameter than correctly Call the given TL method (You shouldn't need to use this method directly) Expected type of the returned object TL method structure Wait for the reply and return the resulting object, or throws an RpcException if an error was replied Used to indicate progression of file download/upload transmitted bytes total size of file in bytes, or 0 if unknown Helper method to upload a file to Telegram Path to the file to upload (optional) Callback for tracking the progression of the transfer an or than can be used in various requests Helper method to upload a file to Telegram Content of the file to upload. This method close/dispose the stream Name of the file (optional) Callback for tracking the progression of the transfer an or than can be used in various requests Search messages in chat with filter and text See See for a list of possible filter types User or chat, histories with which are searched, or constructor for global search Text search request Only return messages starting from the specified message ID Number of results to return Search messages globally with filter and text See See for a list of possible filter types Text search request Only return messages starting from the specified message ID Number of results to return Helper method to send a media message more easily Destination of message (chat group, channel, user chat, etc..) Caption for the media (in plain text) or Media file already uploaded to TG (see UploadFileAsync) for automatic detection, "photo" for an inline photo, "video" for a streamable MP4 video, or a MIME type to send as a document Your message is a reply to an existing message with this ID, in the same chat Text formatting entities for the caption. You can use MarkdownToEntities to create these UTC timestamp when the message should be sent The transmitted message confirmed by Telegram Helper method to send a text or media message easily Destination of message (chat group, channel, user chat, etc..) The plain text of the message (or media caption) An instance of InputMedia-derived class, or if there is no associated media Your message is a reply to an existing message with this ID, in the same chat Text formatting entities. You can use HtmlToEntities or MarkdownToEntities to create these UTC timestamp when the message should be sent Should website/media preview be shown below, above or not, for URL links in your message The transmitted message as confirmed by Telegram Helper method to send an album (media group) of photos or documents more easily Destination of message (chat group, channel, user chat, etc..) An array or List of InputMedia-derived class Caption for the media (in plain text) or Your message is a reply to an existing message with this ID, in the same chat Text formatting entities for the caption. You can use MarkdownToEntities to create these UTC timestamp when the message should be sent Any URL pointing to a video should be considered as non-streamable The media group messages, as received by Telegram * The caption/entities are set on the first media
* and are supported natively for bot accounts, and for user accounts by downloading the file from the web via HttpClient and sending it to Telegram. WTelegramClient proxy settings don't apply to HttpClient
* You may run into errors if you mix, in the same album, photos and file documents having no thumbnails/video attributes Helper method to forwards messages more easily by their IDs. Whether to forward messages without quoting the original author Whether to strip captions from media Source of messages IDs of messages Destination peer Destination forum topic The resulting forwarded messages, as received by Telegram Some of them might be if they could not all be forwarded Download a photo from Telegram into the outputStream The photo to download Stream to write the file content to. This method does not close/dispose the stream A specific size/version of the photo, or to download the largest version of the photo (optional) Callback for tracking the progression of the transfer The file type of the photo Download a document from Telegram into the outputStream The document to download Stream to write the file content to. This method does not close/dispose the stream A specific size/version of the document thumbnail to download, or to download the document itself (optional) Callback for tracking the progression of the transfer MIME type of the document/thumbnail Download a file from Telegram into the outputStream Telegram file identifier, typically obtained with a .ToFileLocation() call Stream to write file content to. This method does not close/dispose the stream (optional) DC on which the file is stored (optional) Expected file size (optional) Callback for tracking the progression of the transfer The file type Download the profile photo for a given peer into the outputStream User, Chat or Channel Stream to write the file content to. This method does not close/dispose the stream Whether to download the high-quality version of the picture Whether to extract the embedded very low-res thumbnail (synchronous, no actual download needed) The file type of the photo, or 0 if no photo available Get all chats, channels and supergroups Returns the current user dialog list. Possible codes: 400 (details) Peer folder ID, for more info click here See Helper method that tries to fetch all participants from a Channel (beyond Telegram server-side limitations) The channel to query Also fetch the kicked/banned members? first letters used to search for in participants names
(default values crafted with ♥ to find most latin and cyrillic names) second (and further) letters used to search for in participants names Can be used to abort the work of this method Field count indicates the total count of members. Field participants contains those that were successfully fetched ⚠ This method can take a few minutes to complete on big broadcast channels. It likely won't be able to obtain the full total count of members Helper simplified method: Get the admin log of a channel/supergroup See Possible codes: 400,403 (details) Channel Search query, can be empty Event filter Only show events from this admin Helper simplified method: Get all topics of a forum See Possible codes: 400 (details) Supergroup Search query Generic helper: Adds a single user to a Chat or Channel See
and Possible codes: 400,403 Chat/Channel User to be added Generic helper: Kick a user from a Chat or Channel [bots: ✓] See
and Possible codes: 400,403 Chat/Channel User to be removed Generic helper: Leave a Chat or Channel [bots: ✓] See
and Possible codes: 400,403 Chat/Channel to leave Generic helper: Make a user admin in a Chat or Channel See
and [bots: ✓] Possible codes: 400,403,406 Chat/Channel The user to make admin Whether to make them admin Generic helper: Change the photo of a Chat or Channel [bots: ✓] See
and Possible codes: 400,403 Chat/Channel New photo Generic helper: Edit the name of a Chat or Channel [bots: ✓] See
and Possible codes: 400,403 Chat/Channel New name Get full info about a Chat or Channel [bots: ✓] See
and Possible codes: 400,403,406 Chat/Channel Generic helper: Delete a Chat or Channel See
and Possible codes: 400,403,406 Chat/Channel to delete If you want to get all messages from a chat, use method Messages_GetHistory Generic helper: Get individual messages by IDs [bots: ✓] See
and Possible codes: 400 User/Chat/Channel IDs of messages to get Generic helper: Delete messages by IDs [bots: ✓]
Messages are deleted for all participants See
and Possible codes: 400,403 User/Chat/Channel IDs of messages to delete Generic helper: Marks message history as read. See
and Possible codes: 400 User/Chat/Channel If a positive value is passed, only messages with identifiers less or equal than the given one will be marked read Return information about a chat/channel based on Invite Link or Public Link Public link or Invite link, like https://t.me/+InviteHash, https://t.me/joinchat/InviteHash or https://t.me/channelname
Works also without https:// prefix to also join the chat/channel previously collected chats, to prevent unnecessary ResolveUsername a Chat or Channel, possibly partial Channel information only (with flag ) Return chat and message details based on a Message Link (URL) Message Link, like https://t.me/c/1234567890/1234 or t.me/channelname/1234 previously collected chats, to prevent unnecessary ResolveUsername Structure containing the message, chat and user details If link is for private group (t.me/c/..), user must have joined that group Callback for logging a line (string) with its associated severity level (int) For serializing indented Json with fields included Get a cryptographic random 64-bit value Miller–Rabin primality test The number to check for primality Instantiate a Secret Chats manager The Telegram client File path to load/save secret chats keys/status (optional) Terminate the secret chat Secret Chat ID Whether to delete the entire chat history for the other user as well Initiate a secret chat with the given user.
(chat must be acknowledged by remote user before being active) The remote user Secret Chat ID Processes the you received from Telegram (). If update.chat is , you might want to first make sure you want to accept this secret chat initiated by user Incoming requests for secret chats are automatically: accepted (), rejected () or ignored () if the update was handled successfully Encrypt and send a message on a secret chat You would typically pass an instance of or that you created and filled
Remember to fill random_id with , and the flags field if necessary Secret Chat ID The pre-filled DecryptedMessage or DecryptedMessageService to send Send encrypted message without a notification Optional file attachment. See method UploadFile Confirmation of sent message Decrypt an encrypted message obtained in Encrypted If messages are missing or received in wrong order, automatically request to resend missing messages An array of DecryptedMessage or DecryptedMessageService from various TL.LayerXX namespaces.
You can use the generic properties to access their fields May return an empty array if msg was already previously received or is not the next message in sequence.
May return multiple messages if missing messages are finally received (using = true) Upload a file to Telegram in encrypted form Content of the file to upload. This method close/dispose the stream The associated media structure that will be updated with file size and the random AES key/iv (optional) Callback for tracking the progression of the transfer the uploaded file info that should be passed to method SendMessage Download and decrypt an encrypted file from Telegram Secret Chat into the outputStream The encrypted file to download & decrypt The associated message media structure Stream to write the decrypted file content to. This method does not close/dispose the stream (optional) Callback for tracking the progression of the transfer The mime type of the decrypted file, if unknown Collected info about Users (only if using the default collector) Collected info about Chats (only if using the default collector) Timout to detect lack of updates and force refetch them Logging callback (defaults to WTelegram.Helpers.Log ; can be null for performance) Current set of update states (for saving and later resume) Manager ensuring that you receive Telegram updates in correct order, without missing any the WTelegram Client to manage Event to be called on sequential individual update (optional) Resume session by recovering all updates that occured since this state Custom users/chats collector. By default, those are collected in properties Users/Chats if your method can be called again even when last async call didn't return yet Load latest dialogs states, checking for missing updates structure returned by Messages_Get*Dialogs calls Dangerous! Load full history of unknown new channels as updates Save the current state of the manager to JSON file File path to write Note: This does not save the the content of collected Users/Chats dictionaries returns a or for the given Peer (only if using the default collector) Accumulate users/chats found in this structure in your dictionaries, ignoring Min constructors when the full object is already stored The structure having a users Converts a Markdown text into the (plain text + entities) format used by Telegram messages not used anymore, you can pass null [in] The Markdown text
[out] The same (plain) text, stripped of all Markdown notation Generate premium entities if any Dictionary used for tg://user?id= notation The array of formatting entities that you can pass (along with the plain text) to SendMessageAsync or SendMediaAsync Converts the (plain text + entities) format used by Telegram messages into a Markdown text Client, used only for getting current user ID in case of InputMessageEntityMentionName+InputUserSelf The plain text, typically obtained from The array of formatting entities, typically obtained from Convert premium entities (might lead to non-standard markdown) The message text with MarkdownV2 formattings Insert backslashes in front of Markdown reserved characters The text to escape The escaped text, ready to be used in MarkdownToEntities without problems Converts an HTML-formatted text into the (plain text + entities) format used by Telegram messages not used anymore, you can pass null [in] The HTML-formatted text
[out] The same (plain) text, stripped of all HTML tags Generate premium entities if any Dictionary used for tg://user?id= notation The array of formatting entities that you can pass (along with the plain text) to SendMessageAsync or SendMediaAsync Converts the (plain text + entities) format used by Telegram messages into an HTML-formatted text Client, used only for getting current user ID in case of InputMessageEntityMentionName+InputUserSelf The plain text, typically obtained from The array of formatting entities, typically obtained from Convert premium entities The message text with HTML formatting tags Replace special HTML characters with their &xx; equivalent The text to make HTML-safe The HTML-safe text, ready to be used in HtmlToEntities without problems The value of X in the message, -1 if no variable X was found See See See Boolean type. See Constructor may be interpreted as a booleanfalse value. The constructor can be interpreted as a booleantrue value. See predefined identifiers. See Error. See Error code Message Corresponds to an arbitrary empty object. See a value means null Peer See Derived classes: , , , , , a value means inputPeerEmpty Defines the current user. See Defines a chat for further interaction. See Chat identifier ⚠ This type is only for basic Chat. See Terminology in the README to understand what this means
Chat groups of type Channel must use . Chat identifier Defines a user for further interaction. See User identifier ⚠ REQUIRED FIELD. See how to obtain it
access_hash value from the User identifier ⚠ REQUIRED FIELD. See FAQ for how to obtain it
access_hash value from the structure Defines a channel for further interaction. See Channel identifier ⚠ REQUIRED FIELD. See how to obtain it
access_hash value from the Channel identifier ⚠ REQUIRED FIELD. See FAQ for how to obtain it
access_hash value from the structure Defines a min user that was seen in a certain message of a certain chat. See The chat where the user was seen The message ID The identifier of the user that was seen Defines a min channel that was seen in a certain message of a certain chat. See The chat where the channel's message was seen The message ID The identifier of the channel that was seen Defines a user for subsequent interaction. See Derived classes: , , a value means inputUserEmpty Defines the current user. See Defines a user for further interaction. See User identifier ⚠ REQUIRED FIELD. See how to obtain it
access_hash value from the User identifier ⚠ REQUIRED FIELD. See FAQ for how to obtain it
access_hash value from the structure Defines a min user that was seen in a certain message of a certain chat. See The chat where the user was seen The message ID The identifier of the user that was seen Object defines a contact from the user's phone book. See Derived classes: Phone contact. See An arbitrary 64-bit integer: it should be set, for example, to an incremental number when using Contacts_ImportContacts, in order to retry importing only the contacts that weren't imported successfully, according to the client_ids returned in .retry_contacts. Phone number Contact's first name Contact's last name Defines a file uploaded by the client. See Derived classes: , , for a profile photo. for auto-detection
for a profile video. The video MUST be square, 10 seconds max, larger than 160x160 Random file identifier created by the client Number of parts saved Full name of the file Defines a file saved in parts using the method Upload_SaveFilePart. See Random file identifier created by the client Number of parts saved Full name of the file In case the file's md5-hash was passed, contents of the file will be checked prior to use Assigns a big file (over 10 MB in size), saved in part using the method Upload_SaveBigFilePart. See Random file id, created by the client Number of parts saved Full file name Used to edit the thumbnail/static preview of a story, see here » for more info on the full flow. See The old story video. Defines media content of a message. See Derived classes: , , , , , , , , , , , , , , , , a value means inputMediaEmpty Photo See Extra bits of information, use flags.HasFlag(...) to test for those The uploaded file Attached mask stickers Time to live in seconds of self-destructing photo Field has a value Field has a value Whether this media should be hidden behind a spoiler warning Forwarded photo See Extra bits of information, use flags.HasFlag(...) to test for those Photo to be forwarded Time to live in seconds of self-destructing photo Field has a value Whether this media should be hidden behind a spoiler warning Map. See GeoPoint Phone book contact See Phone number Contact's first name Contact's last name Contact vcard New document See Extra bits of information, use flags.HasFlag(...) to test for those The uploaded file Thumbnail of the document, uploaded as for the file MIME type of document Attributes that specify the type of the document (video, audio, voice, sticker, etc.) Attached stickers Time to live in seconds of self-destructing document Field has a value Field has a value Field has a value Whether the specified document is a video file with no audio tracks (a GIF animation (even as MPEG4), for example) Force the media file to be uploaded as document Whether this media should be hidden behind a spoiler warning Forwarded document See Extra bits of information, use flags.HasFlag(...) to test for those The document to be forwarded. Time to live of self-destructing document Text query or emoji that was used by the user to find this sticker or GIF: used to improve search result relevance. Field has a value Field has a value Whether this media should be hidden behind a spoiler warning Can be used to send a venue geolocation. See Geolocation Venue name Physical address of the venue Venue provider: currently only "foursquare" and "gplaces" (Google Places) need to be supported Venue ID in the provider's database Venue type in the provider's database New photo that will be uploaded by the server using the specified URL See Extra bits of information, use flags.HasFlag(...) to test for those URL of the photo Self-destruct time to live of photo Field has a value Whether this media should be hidden behind a spoiler warning Document that will be downloaded by the telegram servers See Extra bits of information, use flags.HasFlag(...) to test for those URL of the document Self-destruct time to live of document Field has a value Whether this media should be hidden behind a spoiler warning A game See The game to forward Generated invoice of a bot payment See Extra bits of information, use flags.HasFlag(...) to test for those Product name, 1-32 characters Product description, 1-255 characters URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. The actual invoice Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. Payments provider token, obtained via Botfather JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. Unique bot deep links start parameter. If present, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter. If absent, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. Deprecated Field has a value Field has a value Field has a value Field has a value Live geolocation See Extra bits of information, use flags.HasFlag(...) to test for those Current geolocation For live locations, a direction in which the location moves, in degrees; 1-360. Validity period of the current location For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000) Whether sending of the geolocation was stopped Field has a value Field has a value Field has a value A poll See Extra bits of information, use flags.HasFlag(...) to test for those The poll to send Correct answer IDs (for quiz polls) Explanation of quiz solution Message entities for styled text Field has a value Fields and have a value Send a dice-based animated sticker See The emoji, for now 🏀, 🎲 and 🎯 are supported Forwarded story See Peer where the story was posted Story ID Specifies options that will be used to generate the link preview for the caption, or even a standalone link preview without an attached message. See Extra bits of information, use flags.HasFlag(...) to test for those The URL to use for the link preview. If set, specifies that a large media preview should be used. If set, specifies that a small media preview should be used. If not set, a WEBPAGE_NOT_FOUND RPC error will be emitted if a webpage preview cannot be generated for the specified url; otherwise, no error will be emitted (unless the provided message is also empty, in which case a MESSAGE_EMPTY will be emitted, instead). Paid media, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those The price of the media in Telegram Stars. Photos or videos. Bots only, specifies a custom payload that will then be passed in when a payment is made (this field will not be visible to the user) Field has a value Defines a new group profile photo. See Derived classes: , a value means inputChatPhotoEmpty New photo to be set as group profile photo. See Extra bits of information, use flags.HasFlag(...) to test for those File saved in parts using the method Upload_SaveFilePart Square video for animated profile picture Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if video or video_emoji_markup is set. Animated sticker profile picture, must contain either a or a . Field has a value Field has a value Field has a value Field has a value Existing photo to be set as a chat profile photo. See Existing photo Defines a GeoPoint by its coordinates. See a value means inputGeoPointEmpty Extra bits of information, use flags.HasFlag(...) to test for those Latitude Longitude The estimated horizontal accuracy of the location, in meters; as defined by the sender. Field has a value Defines a photo for further interaction. See a value means inputPhotoEmpty Photo identifier ⚠ REQUIRED FIELD. See how to obtain it
access_hash value from the File reference Defines the location of a file for download. See Derived classes: , , , , , , , , , DEPRECATED location of a photo See Server volume File identifier Check sum to access the file File reference Location of encrypted secret chat file. See File ID, id parameter value from ⚠ REQUIRED FIELD. See how to obtain it
Checksum, access_hash parameter value from Document location (video, voice, audio, basically every type except photo) See Document ID ⚠ REQUIRED FIELD. See how to obtain it
access_hash parameter from the File reference Thumbnail size to download the thumbnail Location of encrypted telegram passport file. See File ID, id parameter value from ⚠ REQUIRED FIELD. See how to obtain it
Checksum, access_hash parameter value from Used to download a JSON file that will contain all personal data related to features that do not have a specialized takeout method yet, see here » for more info on the takeout API. See Use this object to download a photo with Upload_GetFile method See Photo ID, obtained from the object ⚠ REQUIRED FIELD. See how to obtain it
Photo's access hash, obtained from the object File reference The to download: must be set to the type field of the desired PhotoSize object of the DEPRECATED legacy photo file location See Photo ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash File reference Volume ID Local ID Secret Location of profile photo of channel/group/supergroup/user See Extra bits of information, use flags.HasFlag(...) to test for those The peer whose profile picture should be downloaded Photo ID Whether to download the high-quality version of the picture Location of stickerset thumbnail (see files) See Sticker set Thumbnail version Chunk of a livestream See Extra bits of information, use flags.HasFlag(...) to test for those Livestream info Timestamp in milliseconds Specifies the duration of the video segment to fetch in milliseconds, by bitshifting 1000 to the right scale times: duration_ms := 1000 >> scale Selected video channel Selected video quality (0 = lowest, 1 = medium, 2 = best) Fields and have a value Identifier of a private chat, basic group, group or channel (see here » for more info). See Derived classes: , , Use the UserOrChat(peer) method from the root class you received, in order to convert this to a more useful or Chat partner See User identifier Group. See Group identifier Channel/supergroup See Channel ID Object describes the file type. See Unknown type. Part of a bigger file. JPEG image. MIME type: image/jpeg. GIF image. MIME type: image/gif. PNG image. MIME type: image/png. PDF document image. MIME type: application/pdf. Mp3 audio. MIME type: audio/mpeg. Quicktime video. MIME type: video/quicktime. MPEG-4 video. MIME type: video/mp4. WEBP image. MIME type: image/webp. Object defines a user. See Derived classes: , Empty constructor, non-existent user. See User identifier or 0 Indicates info about a certain user. See Extra bits of information, use flags.HasFlag(...) to test for those Extra bits of information, use flags2.HasFlag(...) to test for those ID of the user, see here » for more info. Access hash of the user, see here » for more info.
If this flag is set, when updating the local peer database, generate a virtual flag called min_access_hash, which is:
- Set to true if min is set AND
-- The phone flag is not set OR
-- The phone flag is set and the associated phone number string is non-empty
- Set to false otherwise.

Then, apply both access_hash and min_access_hash to the local database if:
- min_access_hash is false OR
- min_access_hash is true AND
-- There is no locally cached object for this user OR
-- There is no access_hash in the local cache OR
-- The cached object's min_access_hash is also true

If the final merged object stored to the database has the min_access_hash field set to true, the related access_hash is only suitable to use in inputPeerPhotoFileLocation », to directly download the profile pictures of users, everywhere else a inputPeer*FromMessage constructor will have to be generated as specified here ».
Bots can also use min access hashes in some conditions, by passing 0 instead of the min access hash. First name.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set. Last name.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set. Main active username.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set.
Changes to this flag should invalidate the local cache for this user ID if the above conditions are respected and the bot_can_edit flag is also set. Phone number.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set. Profile picture of user.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The apply_min_photo flag is set OR
-- The min flag of the locally cached user entry is set. Online status of user.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set OR
-- The locally cached user entry is equal to . Version of the bot_info field in userFull, incremented every time it changes.
Changes to this flag should invalidate the local cache for this user ID, see here » for more info. Contains the reason why access to this user must be restricted. Inline placeholder for this inline bot Language code of the user Emoji status Additional usernames.
When updating the local peer database, apply changes to this field only if:
- The min flag is not set OR
- The min flag is set AND
-- The min flag of the locally cached user entry is set.
Changes to this flag (if the above conditions are respected) should invalidate the local cache for this user ID. ID of the maximum read story.
When updating the local peer database, do not apply changes to this field if the min flag of the incoming constructor is set. The user's accent color. The user's profile color. Monthly Active Users (MAU) of this bot (may be absent for small bots). Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Whether this user indicates the currently logged in user Whether this user is a contact
When updating the local peer database, do not apply changes to this field if the min flag is set. Whether this user is a mutual contact.
When updating the local peer database, do not apply changes to this field if the min flag is set. Whether the account of this user was deleted.
Changes to this flag should invalidate the local cache for this user ID, see here » for more info. Is this user a bot?
Changes to this flag should invalidate the local cache for this user ID, see here » for more info. Can the bot see all messages in groups? Can the bot be added to groups? Whether this user is verified Access to this user must be restricted for the reason specified in restriction_reason Field has a value See min Whether the bot can request our geolocation in inline mode Field has a value Whether this is an official support user This may be a scam user If set and min is set, the value of photo can be used to update the local database, see the documentation of that flag for more info. If set, this user was reported by many users as a fake or scam user: be careful when interacting with them. Whether this bot offers an attachment menu web app Whether this user is a Telegram Premium user
Changes to this flag should invalidate the local cache for this user ID, see here » for more info.
Changes to this flag if the self flag is set should also trigger the following calls, to refresh the respective caches:
- The Help_GetConfig cache
- The Messages_GetTopReactions cache if the bot flag is not set Whether we installed the attachment menu web app offered by this bot.
When updating the local peer database, do not apply changes to this field if the min flag is set. Field has a value Field has a value Whether we can edit the profile picture, name, about text and description of this bot because we own it.
When updating the local peer database, do not apply changes to this field if the min flag is set.
Changes to this flag (if min is not set) should invalidate the local cache for this user ID. Whether we marked this user as a close friend, see here » for more info.
When updating the local peer database, do not apply changes to this field if the min flag is set. Whether we have hidden » all active stories of this user.
When updating the local peer database, do not apply changes to this field if the min flag is set. No stories from this user are visible. Field has a value Field has a value Field has a value If set, we can only write to this user if they have already sent some messages to us, if we are subscribed to Telegram Premium, or if they're a mutual contact (.mutual_contact).
All the secondary conditions listed above must be checked separately to verify whether we can still write to the user, even if this flag is set (i.e. a mutual contact will have this flag set even if we can still write to them, and so on...); to avoid doing these extra checks if we haven't yet cached all the required information (for example while displaying the chat list in the sharing UI) the Users_GetIsPremiumRequiredToContact method may be invoked instead, passing the list of users currently visible in the UI, returning a list of booleans that directly specify whether we can or cannot write to each user; alternatively, the .contact_require_premium flag contains the same (fully checked, i.e. it's not just a copy of this flag) info returned by Users_GetIsPremiumRequiredToContact.
To set this flag for ourselves invoke Account_SetGlobalPrivacySettings, setting the settings.new_noncontact_peers_require_premium flag. Whether this bot can be connected to a user as specified here ». Field has a value If set, this bot has configured a Main Mini App ». An estimation of the number of days ago the user was last seen (Online=0, Recently=1, LastWeek=5, LastMonth=20, LongTimeAgo=150) User profile photo. See a value means userProfilePhotoEmpty Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the respective photo Stripped thumbnail DC ID where the photo is stored Whether an animated profile picture is available for this user Field has a value Whether this profile photo is only visible to us (i.e. it was set using Photos_UploadContactProfilePhoto). User online status See Derived classes: , , , , a value means userStatusEmpty a null value means userStatusEmpty = last seen a long time ago, more than a month (or blocked/deleted users) Online status of the user. See Time to expiration of the current online status The user's offline status. See Time the user was last seen online Online status: last seen recently See covers anything between 1 second and 2-3 days Extra bits of information, use flags.HasFlag(...) to test for those If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here » for more info. Online status: last seen last week See between 2-3 and seven days Extra bits of information, use flags.HasFlag(...) to test for those If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here » for more info. Online status: last seen last month See between 6-7 days and a month Extra bits of information, use flags.HasFlag(...) to test for those If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here » for more info. Object defines a group. See Derived classes: , , , , ID of the group, see here » for more info Title Is this chat among current user active chats? Is this chat a broadcast channel? returns true if you're banned of any of these rights Empty constructor, group doesn't exist See Group identifier Group identifier Info about a group. See Extra bits of information, use flags.HasFlag(...) to test for those ID of the group, see here » for more info Title Chat photo Participant count Date of creation of the group Used in basic groups to reorder updates and make sure that all of them were received. Means this chat was upgraded to a supergroup Admin rights of the user in the group Default banned rights of all users in the group Whether the current user is the creator of the group Whether the current user has left the group Whether the group was migrated Field has a value Field has a value Field has a value Whether a group call is currently active Whether there's anyone in the group call Whether this group is protected, thus does not allow forwarding messages from it ID of the group, see here » for more info Title A group to which the user has no access. E.g., because the user was kicked from the group. See User identifier Group name User identifier Group name Channel/supergroup info See Extra bits of information, use flags.HasFlag(...) to test for those Extra bits of information, use flags2.HasFlag(...) to test for those ID of the channel, see here » for more info Access hash, see here » for more info Title Main active username. Profile photo Date when the user joined the supergroup/channel, or if the user isn't a member, its creation date Contains the reason why access to this channel must be restricted.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Admin rights of the user in this channel (see rights) Banned rights of the user in this channel (see rights) Default chat rights (see rights) Participant count Additional usernames ID of the maximum read story. The channel's accent color. The channel's profile color. Emoji status Boost level.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Expiration date of the Telegram Star subscription » the current user has bought to gain access to this channel. Whether the current user is the creator of this channel Whether the current user has left or is not a member of this channel Is this a channel? Field has a value Is this channel verified by telegram? Is this a supergroup?
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether viewing/writing in this channel for a reason (see restriction_reason) Whether signatures are enabled (channels) See min Field has a value Field has a value Field has a value Field has a value Field has a value This channel/supergroup is probably a scam
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether this channel has a linked discussion group » (or this supergroup is a channel's discussion group). The actual ID of the linked channel/supergroup is contained in .linked_chat_id.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether this chanel has a geoposition Whether slow mode is enabled for groups to prevent flood in chat.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether a group call or livestream is currently active Whether there's anyone in the group call or livestream If set, this supergroup/channel was reported by many users as a fake or scam: be careful when interacting with it.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether this supergroup is a gigagroup
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether this channel or group is protected, thus does not allow forwarding messages from it Whether a user needs to join the supergroup before they can send messages: can be false only for discussion groups », toggle using Channels_ToggleJoinToSend
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether a user's join request will have to be approved by administrators, toggle using Channels_ToggleJoinRequest
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Whether this supergroup is a forum.
Changes to this flag should invalidate the local cache for this channel/supergroup ID, see here » for more info. Field has a value Whether we have hidden all stories posted by this channel ». If set, indicates that the stories_hidden flag was not populated, and its value must cannot be relied on; use the previously cached value, or re-fetch the constructor using Channels_GetChannels to obtain the latest value of the stories_hidden flag. No stories from the channel are visible. Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value If set, messages sent by admins to this channel will link to the admin's profile (just like with groups). ID of the channel, see here » for more info Title Indicates a channel/supergroup we can't access because we were banned, or for some other reason. See Extra bits of information, use flags.HasFlag(...) to test for those Channel ID Access hash Title The ban is valid until the specified date Is this a channel Is this a supergroup Field has a value Channel ID Title Full info about a channel, supergroup, gigagroup or basic group. See Derived classes: , ID of the chat About string for this chat Chat photo Notification settings Chat invite Info about bots that are in this chat Message ID of the last pinned message Peer folder ID, for more info click here Group call information Time-To-Live of messages sent by the current user to this chat When using Phone_GetGroupCallJoinAs to get a list of peers that can be used to join a group call, this field indicates the peer that should be selected by default. Emoji representing a specific chat theme Pending join requests » IDs of users who requested to join recently Allowed message reactions » This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max). Full info about a basic group. See Extra bits of information, use flags.HasFlag(...) to test for those ID of the chat About string for this chat Participant list Chat photo Notification settings Chat invite Info about bots that are in this chat Message ID of the last pinned message Peer folder ID, for more info click here Group call information Time-To-Live of messages sent by the current user to this chat When using Phone_GetGroupCallJoinAs to get a list of peers that can be used to join a group call, this field indicates the peer that should be selected by default. Emoji representing a specific chat theme Pending join requests » IDs of users who requested to join recently Allowed message reactions » This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max). Field has a value Field has a value Field has a value Can we change the username of this chat Whether scheduled messages are available Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Fields and have a value Field has a value Whether the real-time chat translation popup should be hidden. Field has a value ID of the chat About string for this chat Chat photo Notification settings Chat invite Info about bots that are in this chat Message ID of the last pinned message Peer folder ID, for more info click here Group call information Time-To-Live of messages sent by the current user to this chat When using Phone_GetGroupCallJoinAs to get a list of peers that can be used to join a group call, this field indicates the peer that should be selected by default. Emoji representing a specific chat theme Pending join requests » IDs of users who requested to join recently Allowed message reactions » This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max). Full info about a channel, supergroup or gigagroup. See Extra bits of information, use flags.HasFlag(...) to test for those Extra bits of information, use flags2.HasFlag(...) to test for those ID of the channel Info about the channel Number of participants of the channel Number of channel admins Number of users kicked from the channel Number of users banned from the channel Number of users currently online Position up to which all incoming messages are read. Position up to which all outgoing messages are read. Count of unread messages Channel picture Notification settings Invite link Info about bots in the channel/supergroup The chat ID from which this group was migrated The message ID in the original chat at which this group was migrated Message ID of the last pinned message Associated stickerset Identifier of a maximum unavailable message in a channel due to hidden history. Peer folder ID, for more info click here ID of the linked discussion chat for channels (and vice versa, the ID of the linked channel for discussion chats). Location of the geogroup If specified, users in supergroups will only be able to send one message every slowmode_seconds seconds Indicates when the user will be allowed to send another message in the supergroup (unixtime) If set, specifies the DC to use for fetching channel statistics Latest PTS for this channel Livestream or group call information Time-To-Live of messages in this channel or supergroup A list of suggested actions for the supergroup admin, see here for more info ». When using Phone_GetGroupCallJoinAs to get a list of peers that can be used to join a group call, this field indicates the peer that should be selected by default. Emoji representing a specific chat theme Pending join requests » IDs of users who requested to join recently Default peer used for sending messages to this channel Allowed message reactions » This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max). Channel stories Wallpaper The number of boosts the current user has applied to the current supergroup. The number of boosts this supergroup requires to bypass slowmode and other restrictions, see here » for more info. Custom emoji stickerset associated to the current supergroup, set using Channels_SetEmojiStickers after reaching the appropriate boost level, see here » for more info. Field has a value Field has a value Fields and have a value Can we view the participant list? Fields and have a value Field has a value Can we set the channel's username? Can we Channels_SetStickers a stickerpack to the supergroup? Field has a value Field has a value Is the history before we joined hidden to us? Field has a value Field has a value Field has a value Field has a value Field has a value Can we set the geolocation of this group (for geogroups) Field has a value Field has a value Whether scheduled messages are available Can the user view channel/supergroup statistics Field has a value Whether any anonymous admin of this supergroup was blocked: if set, you won't receive messages from anonymous group admins in discussion replies via @replies Field has a value Field has a value Field has a value Field has a value Field has a value Fields and have a value Field has a value Field has a value Can we delete this channel? Whether native antispam functionality is enabled in this supergroup. Whether the participant list is hidden. Whether the real-time chat translation popup should be hidden. Field has a value Whether this user has some pinned stories. Users may also choose to display messages from all topics of a forum as if they were sent to a normal group, using a "View as messages" setting in the local client.
This setting only affects the current account, and is synced to other logged in sessions using the Channels_ToggleViewForumAsMessages method; invoking this method will update the value of this flag. Field has a value Field has a value Field has a value Field has a value Whether ads on this channel were disabled as specified here » (this flag is only visible to the owner of the channel). If set, this user can view ad revenue statistics » for this channel. Field has a value Whether the current user can send or forward paid media » to this channel. If set, this user can view Telegram Star revenue statistics » for this channel. If set, users may send paid Telegram Star reactions » to messages of this channel. ID of the channel Info about the channel Channel picture Notification settings Invite link Info about bots in the channel/supergroup Message ID of the last pinned message Peer folder ID, for more info click here Livestream or group call information Time-To-Live of messages in this channel or supergroup When using Phone_GetGroupCallJoinAs to get a list of peers that can be used to join a group call, this field indicates the peer that should be selected by default. Emoji representing a specific chat theme Pending join requests » IDs of users who requested to join recently Allowed message reactions » This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max). Details of a group member. See Derived classes: , , Member user ID Group member. See Member user ID ID of the user that added the member to the group Date added to the group Member user ID Represents the creator of the group See ID of the user that created the group ID of the user that created the group Chat admin See Object contains info on group members. See Derived classes: , Group ID Info on members is unavailable See Extra bits of information, use flags.HasFlag(...) to test for those Group ID Info about the group membership of the current user Field has a value Group ID Group members. See Group identifier List of group members Group version number Group identifier Group profile photo. See a value means chatPhotoEmpty Extra bits of information, use flags.HasFlag(...) to test for those Photo ID Stripped thumbnail DC where this photo is stored Whether the user has an animated profile picture Field has a value Object describing a message. See Derived classes: , , ID of the message ID of the sender of the message Peer ID, the chat where this message was sent Reply information Date of the message Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Empty constructor, non-existent message. See Extra bits of information, use flags.HasFlag(...) to test for those Message identifier Peer ID, the chat where this message was sent Field has a value Message identifier Peer ID, the chat where this message was sent A message See Extra bits of information, use flags.HasFlag(...) to test for those Extra bits of information, use flags2.HasFlag(...) to test for those ID of the message ID of the sender of the message Supergroups only, contains the number of boosts this user has given the current supergroup, and should be shown in the UI in the header of the message.
Only present for incoming messages from non-anonymous supergroup members that have boosted the supergroup.
Note that this counter should be locally overridden for non-anonymous outgoing messages, according to the current value of .boosts_applied, to ensure the value is correct even for messages sent by the current user before a supergroup was boosted (or after a boost has expired or the number of boosts has changed); do not update this value for incoming messages from other users, even if their boosts have changed. Peer ID, the chat where this message was sent Messages fetched from a saved messages dialog » will have peer= and the saved_peer_id flag set to the ID of the saved dialog.
 Info about forwarded messages ID of the inline bot that generated the message Whether the message was sent by the business bot specified in via_bot_id on behalf of the user. Reply information Date of the message The message Media attachment Reply markup (bot/inline keyboards) Message entities for styled text View count for channel posts Forward counter Info about post comments (for channels) or message replies (for groups) Last edit date of this message Name of the author of this message for channel posts (with signatures enabled) Multiple media messages sent using Messages_SendMultiMedia with the same grouped ID indicate an album or media group Reactions to this message Contains the reason why access to this message must be restricted. Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. If set, this message is a quick reply shortcut message » (note that quick reply shortcut messages sent to a private chat will not have this field set). A message effect that should be played as specified here ». Represents a fact-check ». Is this an outgoing message Field has a value Field has a value Whether we were mentioned in this message Whether there are unread media attachments in this message Field has a value Field has a value Field has a value Field has a value Fields and have a value Field has a value Whether this is a silent message (no notification triggered) Whether this is a channel post Field has a value Field has a value Field has a value Whether this is a scheduled message This is a legacy message: it has to be refetched with the new layer Field has a value Whether the message should be shown as not modified to the user, even if an edit date is present Field has a value Field has a value Whether this message is pinned Field has a value Whether this message is protected and thus cannot be forwarded; clients should also prevent users from saving attached media (i.e. videos should only be streamed, photos should be kept in RAM, et cetera). If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Field has a value Field has a value Field has a value Field has a value If set, the message was sent because of a scheduled action by the message sender, for example, as away, or a greeting service message. Field has a value Field has a value The video contained in the message is currently being processed by the server (i.e. to generate alternative qualities, that will be contained in the final .alt_document), and will be sent once the video is processed, which will happen approximately at the specified date (i.e. messages with this flag set should be treated similarly to scheduled messages, but instead of the scheduled date, date contains the estimated conversion date). ID of the message ID of the sender of the message Peer ID, the chat where this message was sent Reply information Date of the message Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Indicates a service message See Extra bits of information, use flags.HasFlag(...) to test for those Message ID ID of the sender of this message Sender of service message Reply (thread) information Message date Event connected with the service message Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Whether the message is outgoing Field has a value Whether we were mentioned in the message Whether the message contains unread media Field has a value Whether the message is silent Whether it's a channel post This is a legacy message: it has to be refetched with the new layer Field has a value Message ID ID of the sender of this message Sender of service message Reply (thread) information Message date Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Media See Derived classes: , , , , , , , , , , , , , , , a value means messageMediaEmpty Use this helper method to send a copy of the media without downloading it Quiz poll may need to be voted before obtaining the correct answers. Dice will not replicate same value. TTL ignored
May return for Invoice and other unsupported media types Attached photo. See Extra bits of information, use flags.HasFlag(...) to test for those Photo Time to live in seconds of self-destructing photo Field has a value Field has a value Whether this media should be hidden behind a spoiler warning Attached map. See GeoPoint Attached contact. See Phone number Contact's first name Contact's last name VCARD of contact User identifier or 0, if the user with the given phone number is not registered Current version of the client does not support this media type. See Document (video, audio, voice, sticker, any media type except photo) See Extra bits of information, use flags.HasFlag(...) to test for those Attached document Videos only, contains alternative qualities of the video. Time to live of self-destructing document Field has a value Field has a value Whether this is a normal sticker, if not set this is a premium sticker and a premium sticker animation must be played. Whether this media should be hidden behind a spoiler warning Field has a value Whether this is a video. Whether this is a round video. Whether this is a voice message. Preview of webpage See Extra bits of information, use flags.HasFlag(...) to test for those Webpage preview If set, specifies that a large media preview should be used. If set, specifies that a small media preview should be used. If set, indicates that the URL used for the webpage preview was specified manually using , and may not be related to any of the URLs specified in the message. If set, the webpage can be opened directly without user confirmation; otherwise, user confirmation is required, showing the exact URL that will be opened. Venue See Geolocation of venue Venue name Address Venue provider: currently only "foursquare" and "gplaces" (Google Places) need to be supported Venue ID in the provider's database Venue type in the provider's database Telegram game See Game Invoice See Extra bits of information, use flags.HasFlag(...) to test for those Product name, 1-32 characters Product description, 1-255 characters URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. Message ID of receipt: if set, clients should change the text of the first button always attached to the to a localized version of the word Receipt Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Unique bot deep-linking parameter that can be used to generate this invoice Deprecated Field has a value Whether the shipping address was requested Field has a value Whether this is an example invoice Field has a value Indicates a live geolocation See Extra bits of information, use flags.HasFlag(...) to test for those Geolocation For live locations, a direction in which the location moves, in degrees; 1-360 Validity period of provided geolocation For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). Field has a value Field has a value Poll See The poll The results of the poll Dice-based animated sticker See Dice value The emoji, for now 🏀, 🎲 and 🎯 are supported Represents a forwarded story or a story mention. See Extra bits of information, use flags.HasFlag(...) to test for those Peer that posted the story. Story ID The story itself, if absent fetch it using Stories_GetStoriesByID and the peer/id parameters specified above. Field has a value If set, indicates that this someone has mentioned us in this story (i.e. by tagging us in the description) or vice versa, we have mentioned the other peer (if the message is outgoing). Contains info about a giveaway, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those The channels that the user must join to participate in the giveaway. If set, only users residing in these countries can participate in the giveaway, (specified as a list of two-letter ISO 3166-1 alpha-2 country codes); otherwise there are no country-based limitations. Can contain a textual description of additional giveaway prizes. Number of Telegram Premium subscriptions given away. Duration in months of each Telegram Premium subscription in the giveaway. For Telegram Star giveaways, the total number of Telegram Stars being given away. The end date of the giveaway. If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway. Field has a value If set, giveaway winners are public and will be listed in a message that will be automatically sent to the channel once the giveaway ends. Field has a value Field has a value Field has a value A giveaway with public winners has finished, this constructor contains info about the winners. See Extra bits of information, use flags.HasFlag(...) to test for those ID of the channel/supergroup that was automatically boosted by the winners of the giveaway for duration of the Premium subscription. Number of other channels that participated in the giveaway. Identifier of the message with the giveaway in channel_id. Total number of winners in the giveaway. Number of not-yet-claimed prizes. Up to 100 user identifiers of the winners of the giveaway. Duration in months of each Telegram Premium subscription in the giveaway. For Telegram Star giveaways, the total number of Telegram Stars being given away. Can contain a textual description of additional giveaway prizes. Point in time (Unix timestamp) when the winners were selected. May be bigger than winners selection date specified in initial parameters of the giveaway. If set, only new subscribers starting from the giveaway creation date participated in the giveaway. Field has a value If set, the giveaway was canceled and was fully refunded. Field has a value Field has a value Field has a value Paid media, see here » for more info. See The price of the media in Telegram Stars. Either the paid-for media, or super low resolution media previews if the media wasn't purchased yet, see here » for more info. Object describing actions connected to a service message. See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , a value means messageActionEmpty Group created See Group name List of group members Group name changed. See New group name Group profile changed See New group profile photo Group profile photo removed. See New member in the group See Users that were invited to the chat User left the group. See Leaving user ID A user joined the chat via an invite link See ID of the user that created the invite link The channel was created See Original channel/supergroup title Indicates the chat was migrated to the specified supergroup See The supergroup it was migrated to Indicates the channel was migrated from the specified chat See The old chat title The old chat ID A message was pinned See Chat history was cleared See Someone scored in a game See Game ID Score A user just sent a payment to me (a bot) See Extra bits of information, use flags.HasFlag(...) to test for those Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Bot specified invoice payload Order info provided by the user Identifier of the shipping option chosen by the user Provider payment identifier Field has a value Field has a value Whether this is the first payment of a recurring payment we just subscribed to Whether this payment is part of a recurring payment Field has a value A payment was sent See Extra bits of information, use flags.HasFlag(...) to test for those Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). An invoice slug taken from an invoice deep link or from the premium_invoice_slug app config parameter » Field has a value Whether this is the first payment of a recurring payment we just subscribed to Whether this payment is part of a recurring payment Field has a value A phone call See Extra bits of information, use flags.HasFlag(...) to test for those Call ID If the call has ended, the reason why it ended Duration of the call in seconds Field has a value Field has a value Is this a video call? A screenshot of the chat was taken See Custom action (most likely not supported by the current layer, an upgrade might be needed) See Action message We have given the bot permission to send us direct messages. See Extra bits of information, use flags.HasFlag(...) to test for those We have authorized the bot to send us messages by logging into a website via Telegram Login »; this field contains the domain name of the website on which the user has logged in. We have authorized the bot to send us messages by opening the specified bot mini app. Field has a value We have authorized the bot to send us messages by installing the bot's attachment menu. Field has a value We have allowed the bot to send us messages using Bots_AllowSendMessage. Secure telegram passport values were received See Vector with information about documents and other Telegram Passport elements that were shared with the bot Encrypted credentials required to decrypt the data Request for secure telegram passport values was sent See Secure value types A contact just signed up to telegram See A user of the chat is now in proximity of another user See The user or chat that is now in proximity of to_id The user or chat that subscribed to live geolocation proximity alerts Distance, in meters (0-100000) The group call has ended See Extra bits of information, use flags.HasFlag(...) to test for those Group call Group call duration Field has a value A set of users was invited to the group call See The group call The invited users The Time-To-Live of messages in this chat was changed. See Extra bits of information, use flags.HasFlag(...) to test for those New Time-To-Live of all messages sent in this chat; if 0, autodeletion was disabled. If set, the chat TTL setting was set not due to a manual change by one of participants, but automatically because one of the participants has the Messages_SetDefaultHistoryTTL. For example, when a user writes to us for the first time and we have set a default messages TTL of 1 week, this service message (with auto_setting_from=our_userid) will be emitted before our first message. Field has a value A group call was scheduled See The group call When is this group call scheduled to start The chat theme was changed See The emoji that identifies a chat theme A user was accepted into the group by an admin See Data from an opened reply keyboard bot mini app was relayed to the bot that owns it (bot side service message). See Relayed data. Data from an opened reply keyboard bot mini app was relayed to the bot that owns it (user side service message). See Text of the that was pressed to open the web app. Info about a gifted Telegram Premium subscription See Extra bits of information, use flags.HasFlag(...) to test for those Three-letter ISO 4217 currency code Price of the gift in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Duration of the gifted Telegram Premium subscription If the gift was bought using a cryptocurrency, the cryptocurrency name. If the gift was bought using a cryptocurrency, price of the gift in the smallest units of a cryptocurrency. Message attached with the gift Fields and have a value Field has a value A forum topic was created. See Extra bits of information, use flags.HasFlag(...) to test for those Topic name. If no custom emoji icon is specified, specifies the color of the fallback topic icon (RGB), one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F. ID of the custom emoji used as topic icon. Field has a value Forum topic information was edited. See Extra bits of information, use flags.HasFlag(...) to test for those New topic title. ID of the new custom emoji used as topic icon, or if it was removed. Whether the topic was opened or closed. Whether the topic was hidden or unhidden (only valid for the "General" topic, id=1). Field has a value Field has a value Field has a value Field has a value A new profile picture was suggested using Photos_UploadContactProfilePhoto. See The photo that the user suggested we set as profile picture. Contains info about one or more peers that the we (the user) shared with the bot after clicking on a button (service message sent by the user). See button_id contained in the The shared peers The wallpaper » of the current chat was changed. See Extra bits of information, use flags.HasFlag(...) to test for those New wallpaper If set, indicates the user applied a wallpaper » previously sent by the other user in a message. If set, indicates the wallpaper was forcefully applied for both sides, without explicit confirmation from the other side.
If the message is incoming, and we did not like the new wallpaper the other user has chosen for us, we can re-set our previous wallpaper just on our side, by invoking Messages_SetChatWallPaper, providing only the revert flag (and obviously the peer parameter). Contains a Telegram Premium giftcode link. See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the channel/supergroup that created the gift code either directly or through a giveaway: if we import this giftcode link, we will also automatically boost this channel/supergroup. Duration in months of the gifted Telegram Premium subscription. Slug of the Telegram Premium giftcode link Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). If set, the gift was made using the specified cryptocurrency. If crypto_currency is set, contains the paid amount, in the smallest units of the cryptocurrency. Message attached with the gift If set, this gift code was received from a giveaway » started by a channel/supergroup we're subscribed to. Field has a value If set, the link was not redeemed yet. Fields and have a value Field has a value A giveaway was started. See Extra bits of information, use flags.HasFlag(...) to test for those For Telegram Star giveaways, the total number of Telegram Stars being given away. Field has a value A giveaway has ended. See Extra bits of information, use flags.HasFlag(...) to test for those Number of winners in the giveaway Number of undistributed prizes If set, this is a Telegram Star giveaway Some boosts » were applied to the channel or supergroup. See Number of applied boosts. Contains info about one or more peers that the a user shared with the me (the bot) after clicking on a button (service message received by the bot). See button_id contained in the Info about the shared peers. Describes a payment refund (service message received by both users and bots). See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the peer that returned the funds. Currency, XTR for Telegram Stars. Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Bot specified invoice payload (only received by bots). Provider payment identifier Field has a value You gifted or were gifted some Telegram Stars. See Extra bits of information, use flags.HasFlag(...) to test for those Three-letter ISO 4217 currency code Price of the gift in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Amount of gifted stars If the gift was bought using a cryptocurrency, the cryptocurrency name. If the gift was bought using a cryptocurrency, price of the gift in the smallest units of a cryptocurrency. Identifier of the transaction, only visible to the receiver of the gift. Fields and have a value Field has a value You won some Telegram Stars in a Telegram Star giveaway ». See Extra bits of information, use flags.HasFlag(...) to test for those The number of Telegram Stars you won ID of the telegram star transaction. Identifier of the peer that was automatically boosted by the winners of the giveaway. ID of the message containing the You received a gift, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Info about the gift Additional message from the sender of the gift The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.
convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars. If set, the name of the sender of the gift will be hidden if the destination user decides to display the gift on their profile Field has a value Whether this gift was added to the destination user's profile (may be toggled using Payments_SaveStarGift and fetched using Payments_GetUserStarGifts) Whether this gift was converted to Telegram Stars and cannot be displayed on the profile anymore. Field has a value Chat info. See Derived classes: , The chat The latest message ID Chat See Extra bits of information, use flags.HasFlag(...) to test for those The chat The latest message ID Position up to which all incoming messages are read. Position up to which all outgoing messages are read. Number of unread messages Number of unread mentions Number of unread reactions to messages you sent Notification settings PTS Message draft Peer folder ID, for more info click here Time-to-live of all messages sent in this dialog Field has a value Field has a value Is the dialog pinned Whether the chat was manually marked as unread Field has a value Field has a value Users may also choose to display messages from all topics of a forum as if they were sent to a normal group, using a "View as messages" setting in the local client.
This setting only affects the current account, and is synced to other logged in sessions using the Channels_ToggleViewForumAsMessages method; invoking this method will update the value of this flag. The chat The latest message ID Dialog in folder See Extra bits of information, use flags.HasFlag(...) to test for those The folder Peer in folder Latest message ID of dialog Number of unread muted peers in folder Number of unread unmuted peers in folder Number of unread messages from muted peers in folder Number of unread messages from unmuted peers in folder Is this folder pinned Peer in folder Latest message ID of dialog Object describes a photo. See Derived classes: , Empty constructor, non-existent photo See Photo identifier Photo See Extra bits of information, use flags.HasFlag(...) to test for those ID Access hash file reference Date of upload Available sizes for download For animated profiles, the MPEG4 videos DC ID to use for download Whether the photo has mask stickers attached to it Field has a value Location of a certain size of a picture See Derived classes: , , , , , Thumbnail type » Empty constructor. Image with this thumbnail is unavailable. See Thumbnail type » Thumbnail type » Image description. See Thumbnail type » Image width Image height File size Thumbnail type » Description of an image and its content. See Thumbnail type Image width Image height Binary data, file content Thumbnail type A low-resolution compressed JPG payload See Thumbnail type Thumbnail data, see here for more info on decompression » Thumbnail type Progressively encoded photosize See Photosize type » Photo width Photo height Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image. Photosize type » Messages with animated stickers can have a compressed svg (< 300 bytes) to show the outline of the sticker before fetching the actual lottie animation. See Always j Compressed SVG path payload, see here for decompression instructions Always j GeoPoint. See a value means geoPointEmpty Extra bits of information, use flags.HasFlag(...) to test for those Longitude Latitude Access hash The estimated horizontal accuracy of the location, in meters; as defined by the sender. Field has a value Contains info on a confirmation code message sent via SMS, phone call or Telegram. See Derived classes: , Contains info about a sent verification code. See Extra bits of information, use flags.HasFlag(...) to test for those Phone code type Phone code hash, to be stored and later re-used with Auth_SignIn Phone code type that will be sent next, if the phone code is not received within timeout seconds: to send it use Auth_ResendCode Timeout for reception of the phone code Field has a value Field has a value The user successfully authorized using future auth tokens See Authorization info Object contains info on user authorization. See Derived classes: , Contains user authorization info. See Extra bits of information, use flags.HasFlag(...) to test for those Iff setup_password_required is set and the user declines to set a 2-step verification password, they will be able to log into their account via SMS again only after this many days pass. Temporary passport sessions A future auth token Info on authorized user Field has a value Suggests the user to set up a 2-step verification password to be able to log in again Field has a value An account with this phone number doesn't exist on telegram: the user has to enter basic information and sign up See Extra bits of information, use flags.HasFlag(...) to test for those Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram Field has a value Data for copying of authorization between data centers. See current user identifier authorizes key Object defines the set of users and/or groups that generate notifications. See Derived classes: , , , , Notifications generated by a certain user or group. See User or group Notifications generated by all users. See Notifications generated by all groups. See All channels See Notifications generated by a topic in a forum. See Forum ID Topic ID Notification settings. See Extra bits of information, use flags.HasFlag(...) to test for those If the text of the message shall be displayed in notification Peer was muted? Date until which all notifications shall be switched off Identifier of an audio file to play for notifications. Whether story notifications should be disabled. Whether the sender name should be displayed in story notifications. Identifier of an audio file to play for story notifications. Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Notification settings. See Extra bits of information, use flags.HasFlag(...) to test for those (Ternary value) If set, indicates whether or not to display previews of messages in notifications; otherwise the default behavior should be used. (Ternary value) If set, indicates whether to mute or unmute the peer; otherwise the default behavior should be used. Mute all notifications until this date Notification sound for the official iOS application Notification sound for the official android application Notification sound for other applications Whether story notifications should be disabled. Whether the sender name should be displayed in story notifications. Sound for story notifications on the official iOS application Sound for story notifications on the official Android application Sound for story notifications on other applications Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value List of actions that are possible when interacting with this user, to be shown as suggested actions in the chat action bar », see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Distance in meters between us and this peer If set, this is a private chat with an administrator of a chat or channel to which the user sent a join request, and this field contains the chat/channel's title. If set, this is a private chat with an administrator of a chat or channel to which the user sent a join request, and this field contains the timestamp when the join request » was sent. Contains the ID of the business bot » managing this chat, used to display info about the bot in the action bar. Contains a deep link », used to open a management menu in the business bot. This flag is set if and only if business_bot_id is set. Whether we can still report the user for spam Whether we can add the user as contact Whether we can block the user Whether we can share the user's contact Whether a special exception for contacts is needed Whether we can report a geogroup as irrelevant for this location Field has a value Whether this peer was automatically archived according to privacy settings and can be unarchived If set, this is a recently created group chat to which new members can be invited Fields and have a value This flag is set if request_chat_title and request_chat_date fields are set and the join request » is related to a channel (otherwise if only the request fields are set, the join request » is related to a chat). This flag is set if both business_bot_id and business_bot_manage_url are set and all connected business bots » were paused in this chat using Account_ToggleConnectedBotPaused. This flag is set if both business_bot_id and business_bot_manage_url are set and connected business bots » can reply to messages in this chat, as specified by the settings during initial configuration. Fields and have a value Object contains info on a wallpaper. See Derived classes: , Identifier Info on how to generate the wallpaper, according to these instructions ». Represents a wallpaper based on an image. See Identifier Extra bits of information, use flags.HasFlag(...) to test for those Access hash Unique wallpaper ID, used when generating wallpaper links or importing wallpaper links. The actual wallpaper Info on how to generate the wallpaper, according to these instructions ». Whether we created this wallpaper Whether this is the default wallpaper Field has a value Whether this is a pattern wallpaper » Whether this wallpaper should be used in dark mode. Identifier Info on how to generate the wallpaper, according to these instructions ». Represents a wallpaper only based on colors/gradients. See Wallpaper ID Extra bits of information, use flags.HasFlag(...) to test for those Info on how to generate the wallpaper. Whether this is the default wallpaper Field has a value Whether this wallpaper should be used in dark mode. Wallpaper ID Info on how to generate the wallpaper. Report reason See Report for spam Report for violence Report for pornography Report for child abuse Other Report for copyrighted content Report an irrelevant geogroup Report for impersonation Report for illegal drugs Report for divulgation of personal details Extended user info See Extra bits of information, use flags.HasFlag(...) to test for those Extra bits of information, use flags2.HasFlag(...) to test for those User ID Bio of the user Peer settings Personal profile photo, to be shown instead of profile_photo. Profile photo Fallback profile photo, displayed if no photo is present in profile_photo or personal_photo, due to privacy settings. Notification settings For bots, info about the bot (bot commands, etc) Message ID of the last pinned message Chats in common with this user Peer folder ID, for more info click here Time To Live of all messages in this chat; once a message is this many seconds old, it must be deleted. Emoji associated with chat theme Anonymized text to be shown instead of the user's name on forwarded messages A suggested set of administrator rights for the bot, to be shown when adding the bot as admin to a group, see here for more info on how to handle them ». A suggested set of administrator rights for the bot, to be shown when adding the bot as admin to a channel, see here for more info on how to handle them ». Telegram Premium subscriptions gift options Wallpaper to use in the private chat with the user. Active stories » Telegram Business working hours ». Telegram Business location ». Telegram Business greeting message ». Telegram Business away message ». Specifies a custom Telegram Business profile introduction ». Contains info about the user's birthday ». ID of the associated personal channel », that should be shown in the profile page. ID of the latest message of the associated personal channel », that should be previewed in the profile page. Number of gifts the user has chosen to display on their profile Whether you have blocked this user Field has a value Field has a value Field has a value Whether this user can make VoIP calls Whether this user's privacy settings allow you to call them Field has a value Whether you can pin messages in the chat with this user, you can do this only for a chat with yourself Field has a value Whether scheduled messages are available Whether the user can receive video calls Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Whether this user doesn't allow sending voice messages in a private chat with them Field has a value Field has a value Whether the real-time chat translation popup should be hidden. Field has a value Field has a value Whether this user has some pinned stories. Whether we've blocked this user, preventing them from seeing our stories ». Whether the other user has chosen a custom wallpaper for us using Messages_SetChatWallPaper and the for_both flag, see here » for more info. If set, we cannot write to this user: subscribe to Telegram Premium to get permission to write to this user.
To set this flag for ourselves invoke Account_SetGlobalPrivacySettings, setting the settings.new_noncontact_peers_require_premium flag, see here » for more info. If set, we cannot fetch the exact read date of messages we send to this user using Messages_GetOutboxReadDate.
The exact read date of messages might still be unavailable for other reasons, see Messages_GetOutboxReadDate for more info.
To set this flag for ourselves invoke Account_SetGlobalPrivacySettings, setting the settings.hide_read_marks flag. Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Fields and have a value Whether ads were re-enabled for the current account (only accessible to the currently logged-in user), see here » for more info. Field has a value If set, this user can view ad revenue statistics » for this bot. Field has a value A contact of the current user that is registered in the system. See User identifier Current user is in the user's contact list Successfully imported contact. See User identifier The contact's client identifier (passed to one of the constructors) Contact status: online / offline. See User identifier Online status The current user's contact list and info on users. See a value means contacts.contactsNotModified Contact list Number of contacts that were saved successfully User list Info on successfully imported contacts. See List of successfully imported contacts Popular contacts List of contact ids that could not be imported due to system limitation and will need to be imported at a later date. List of users Full list of blocked users. See List of blocked users Blocked chats List of users returns a or for the given Peer Incomplete list of blocked users. See Total number of elements in the list Object contains a list of chats with messages and auxiliary data. See Derived classes: , , List of chats List of last messages from each chat returns a or for the given Peer Full list of chats with messages and auxiliary data. See List of chats List of last messages from each chat List of groups mentioned in the chats List of users mentioned in messages and groups List of chats List of last messages from each chat returns a or for the given Peer Incomplete list of dialogs with messages and auxiliary data. See Total number of dialogs Dialogs haven't changed See Number of dialogs found server-side by the query returns a or for the given Peer Object contains information on list of messages with auxiliary data. See Derived classes: , , , List of messages returns a or for the given Peer Full list of messages with auxiliary data. See List of messages List of chats mentioned in dialogs List of users mentioned in messages and chats List of messages returns a or for the given Peer Incomplete list of messages and auxiliary data. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of messages in the list Rate to use in the offset_rate parameter in the next call to Messages_SearchGlobal Indicates the absolute position of messages[0] within the total result set with count count.
This is useful, for example, if the result was fetched using offset_id, and we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}. Field has a value If set, indicates that the results may be inexact Field has a value Channel messages See Extra bits of information, use flags.HasFlag(...) to test for those Event count after generation Total number of results were found server-side (may not be all included here) Indicates the absolute position of messages[0] within the total result set with count count.
This is useful, for example, if the result was fetched using offset_id, and we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}. Found messages Forum topic information Chats Users If set, returned results may be inexact Field has a value Found messages returns a or for the given Peer No new messages matching the query were found See Number of results found server-side by the given query returns a or for the given Peer List of chats with auxiliary data. See List of chats Partial list of chats, more would have to be fetched with pagination See Total number of results that were found server-side (not all are included in chats) Full info about a channel, supergroup, gigagroup or basic group. See Full info Mentioned chats Mentioned users returns a or for the given Peer Affected part of communication history with the user or in a chat. See If a parameter contains positive value, it is necessary to repeat the method call using the given value; during the proceeding of all the history the value itself shall gradually decrease Object describes message filter. See Derived classes: , , , , , , , , , , , , , , , a value means inputMessagesFilterEmpty Filter for messages containing photos. See Filter for messages containing videos. See Filter for messages containing photos or videos. See Filter for messages containing documents. See Return only messages containing URLs See Return only messages containing gifs See Return only messages containing voice notes See Return only messages containing audio files See Return only chat photo changes See Return only phone calls See Extra bits of information, use flags.HasFlag(...) to test for those Return only missed phone calls Return only round videos and voice notes See Return only round videos See Return only messages where the current user was mentioned. See Return only messages containing geolocations See Return only messages containing contacts See Fetch only pinned messages See Object contains info on events occurred. See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , New message in a private chat or in a basic group. See Message New quantity of actions in a message box Number of generated events Sent message with random_id client identifier was assigned an identifier. See id identifier of a respective Previously transferred client random_id identifier Messages were deleted. See List of identifiers of deleted messages New quality of actions in a message box Number of generated events The user is preparing a message; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing See Action type The user is preparing a message in a group; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing See Peer that started typing (can be the chat itself, in case of anonymous admins). Type of action Composition of chat participants changed. See Updated chat participants Contact status update. See New status Changes the user's first name, last name and username. See New first name. Corresponds to the new value of real_first_name field of the . New last name. Corresponds to the new value of real_last_name field of the . Usernames. A new session logged into the current user's account through an unknown device. See Extra bits of information, use flags.HasFlag(...) to test for those Hash used for caching, for more info click here Authorization date Name of device, for example Android Location, for example USA, NY (IP=1.2.3.4) Whether the session is unconfirmed, see here » for more info. New encrypted message. See Message New qts value, see updates » for more info. Interlocutor is typing a message in an encrypted chat. Update period is 6 second. If upon this time there is no repeated update, it shall be considered that the interlocutor stopped typing. See Chat ID Change of state in an encrypted chat. See Encrypted chat Date of change Communication history in an encrypted chat was marked as read. See Chat ID Maximum value of data for read messages Time when messages were read New group member. See ID of the new member ID of the user, who added member to the group When was the participant added Chat version number A member has left the group. See ID of the user Used in basic groups to reorder updates and make sure that all of them was received. Changes in the data center configuration options. See New connection options Changes in notification settings. See Notification source New notification settings A service message for the user. See Extra bits of information, use flags.HasFlag(...) to test for those When was the notification received
The message must also be stored locally as part of the message history with the user id 777000 (Telegram Notifications). String, identical in format and contents to the type field in API errors. Describes type of service message. It is acceptable to ignore repeated messages of the same type within a short period of time (15 minutes). Message text Media content (optional) Message entities for styled text If set, the message must be displayed in a popup. Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Privacy rules were changed See Peers to which the privacy rules apply New privacy rules A user's phone number was changed See New phone number Incoming messages were read See Extra bits of information, use flags.HasFlag(...) to test for those Peer folder ID, for more info click here Peer Maximum ID of messages read Number of messages that are still unread Event count after generation Number of events that were generated Field has a value Outgoing messages were read See Peer Maximum ID of read outgoing messages Event count after generation Number of events that were generated An instant view webpage preview was generated See Webpage preview Event count after generation Number of events that were generated Contents of messages in the common message box were read See Extra bits of information, use flags.HasFlag(...) to test for those IDs of read messages Event count after generation Number of events that were generated When was the last message in messages marked as read. Field has a value There are new updates in the specified channel, the client must fetch them.
If the difference is too long or if the channel isn't currently in the states, start fetching from the specified pts. See Extra bits of information, use flags.HasFlag(...) to test for those The channel The PTS. Field has a value Channel/supergroup ( and/or ) information was updated. See Channel ID A new message was sent in a channel/supergroup See Incoming messages in a channel/supergroup were read See Extra bits of information, use flags.HasFlag(...) to test for those Peer folder ID, for more info click here Channel/supergroup ID Position up to which all incoming messages are read. Count of messages weren't read yet Event count after generation Field has a value Some messages in a supergroup/channel were deleted See Channel ID The view counter of a message in a channel has changed See ID of the message New view counter Admin permissions of a user in a basic group were changed See ID of the (de)admined user Whether the user was rendered admin Used in basic groups to reorder updates and make sure that all of them was received. A new stickerset was installed See The installed stickerset The order of stickersets was changed See Extra bits of information, use flags.HasFlag(...) to test for those New sticker order by sticker ID Whether the updated stickers are mask stickers Whether the updated stickers are custom emoji stickers Installed stickersets have changed, the client should refetch them as described in the docs. See Extra bits of information, use flags.HasFlag(...) to test for those Whether mask stickersets have changed Whether the list of installed custom emoji stickersets has changed The saved gif list has changed, the client should refetch it using Messages_GetSavedGifs See An incoming inline query See Extra bits of information, use flags.HasFlag(...) to test for those Query ID User that sent the query Text of query Attached geolocation Type of the chat from which the inline query was sent. Offset to navigate through results Field has a value Field has a value The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. See Extra bits of information, use flags.HasFlag(...) to test for those The user that chose the result The query that was used to obtain the result Optional. Sender location, only for bots that require user location The unique identifier for the result that was chosen Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message. Field has a value Field has a value A message was edited in a channel/supergroup See A callback button was pressed, and the button data was sent to the bot that created the button See Extra bits of information, use flags.HasFlag(...) to test for those Query ID ID of the user that pressed the button Chat where the inline keyboard was sent Message ID Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. Callback data Short name of a Game to be returned, serves as the unique identifier for the game Field has a value Field has a value A message was edited See The new edited message PTS PTS count This notification is received by bots when a button is pressed See Extra bits of information, use flags.HasFlag(...) to test for those Query ID ID of the user that pressed the button ID of the inline message with the button Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field. Short name of a Game to be returned, serves as the unique identifier for the game Field has a value Field has a value Outgoing messages in a channel/supergroup were read See Channel/supergroup ID Position up to which all outgoing messages are read. Notifies a change of a message draft. See Extra bits of information, use flags.HasFlag(...) to test for those The peer to which the draft is associated ID of the forum topic to which the draft is associated The draft Field has a value Some featured stickers were marked as read See The recent sticker list was updated See The server-side configuration has changed; the client should re-fetch the config using Help_GetConfig and Help_GetAppConfig. See Common message box sequence PTS has changed, state has to be refetched using updates.getState See A webpage preview of a link in a channel/supergroup message was generated See Channel/supergroup ID A dialog was pinned/unpinned See Extra bits of information, use flags.HasFlag(...) to test for those Peer folder ID, for more info click here The dialog Whether the dialog was pinned Field has a value Pinned dialogs were updated See Extra bits of information, use flags.HasFlag(...) to test for those Peer folder ID, for more info click here New order of pinned dialogs Field has a value Field has a value A new incoming event; for bots only See The event A new incoming query; for bots only See Query identifier Query data Query timeout This object contains information about an incoming shipping query. See Unique query identifier User who sent the query Bot specified invoice payload User specified shipping address This object contains information about an incoming pre-checkout query. See Extra bits of information, use flags.HasFlag(...) to test for those Unique query identifier User who sent the query Bot specified invoice payload Order info provided by the user Identifier of the shipping option chosen by the user Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Field has a value Field has a value An incoming phone call See Phone call A language pack has changed, the client should manually fetch the changed strings using Langpack_GetDifference See Language code Language pack updated See Changed strings The list of favorited stickers was changed, the client should call Messages_GetFavedStickers to refetch the new list See The specified channel/supergroup messages were read See Extra bits of information, use flags.HasFlag(...) to test for those Channel/supergroup ID Forum topic ID. IDs of messages that were read Field has a value All contacts were deleted See The history of a channel/supergroup was hidden. See Identifier of a maximum unavailable message in a channel due to hidden history. The manual unread mark of a chat was changed See Extra bits of information, use flags.HasFlag(...) to test for those The dialog Was the chat marked or unmarked as read The results of a poll have changed See Extra bits of information, use flags.HasFlag(...) to test for those Poll ID If the server knows the client hasn't cached this poll yet, the poll itself New poll results Field has a value Default banned rights in a normal chat were updated See The chat New default banned rights Version The peer list of a peer folder was updated See New peer list Event count after generation Number of events that were generated Settings of a certain peer have changed See The peer Associated peer settings List of peers near you was updated See Geolocated peer list update A message was added to the schedule queue of a chat See Message Some scheduled messages were deleted from the schedule queue of a chat See Extra bits of information, use flags.HasFlag(...) to test for those Peer Deleted scheduled messages Field has a value A cloud theme was updated See Theme Live geoposition message was viewed See The user that viewed the live geoposition Message ID of geoposition message A login token (for login via QR code) was accepted. See A specific peer has voted in a poll See Poll ID The peer that voted in the poll Chosen option(s) New qts value, see updates » for more info. A new folder was added See Extra bits of information, use flags.HasFlag(...) to test for those Folder ID Folder info Field has a value New folder order See Ordered folder IDs Clients should update folder info See Incoming phone call signaling payload See Phone call ID Signaling payload The forward counter of a message in a channel has changed See ID of the message New forward counter Incoming comments in a discussion thread were marked as read See Extra bits of information, use flags.HasFlag(...) to test for those Discussion group ID ID of the group message that started the thread (message in linked discussion group) Message ID of latest read incoming message for this thread If set, contains the ID of the channel that contains the post that started the comment thread in the discussion group (channel_id) If set, contains the ID of the channel post that started the comment thread Fields and have a value Outgoing comments in a discussion thread were marked as read See Supergroup ID ID of the group message that started the thread Message ID of latest read outgoing message for this thread We blocked a peer, see here » for more info on blocklists. See Extra bits of information, use flags.HasFlag(...) to test for those The (un)blocked peer Whether the peer was blocked or unblocked Whether the peer was added/removed to/from the story blocklist; if not set, this update affects the main blocklist, see here » for more info. A user is typing in a supergroup, channel or message thread See Extra bits of information, use flags.HasFlag(...) to test for those Channel ID Thread ID The peer that is typing Whether the user is typing, sending a media or doing something else Field has a value Some messages were pinned in a chat See Extra bits of information, use flags.HasFlag(...) to test for those Peer Message IDs Event count after generation Number of events that were generated Whether the messages were pinned or unpinned Messages were pinned/unpinned in a channel/supergroup See Extra bits of information, use flags.HasFlag(...) to test for those Channel ID Messages Event count after generation Number of events that were generated Whether the messages were pinned or unpinned Chat ( and/or ) information was updated. See Chat ID The participant list of a certain group call has changed See Group call New participant list Version A new groupcall was started See The channel/supergroup where this group call or livestream takes place Info about the group call or livestream The Time-To-Live for messages sent by the current user in a specific chat has changed See Extra bits of information, use flags.HasFlag(...) to test for those The chat The new Time-To-Live Field has a value A user has joined or left a specific chat See Extra bits of information, use flags.HasFlag(...) to test for those Chat ID When did this event occur User that triggered the change (inviter, admin that kicked the user, or the even the user_id itself) User that was affected by the change Previous participant info (empty if this participant just joined) New participant info (empty if this participant just left) The invite that was used to join the group New qts value, see updates » for more info. Field has a value Field has a value Field has a value A participant has left, joined, was banned or admined in a channel or supergroup. See Extra bits of information, use flags.HasFlag(...) to test for those Channel ID Date of the event User that triggered the change (inviter, admin that kicked the user, or the even the user_id itself) User that was affected by the change Previous participant status New participant status Chat invite used to join the channel/supergroup New qts value, see updates » for more info. Field has a value Field has a value Field has a value Whether the participant joined using a chat folder deep link ». A bot was stopped or re-started. See The user ID When did this action occur Whether the bot was stopped or started New qts value, see updates » for more info. New WebRTC parameters See Extra bits of information, use flags.HasFlag(...) to test for those WebRTC parameters Are these parameters related to the screen capture session currently in progress? The command set of a certain bot in a certain chat has changed. See The affected chat ID of the bot that changed its command set New bot commands Someone has requested to join a chat or channel See Chat or channel Number of pending join requests » for the chat or channel IDs of users that have recently requested to join Someone has requested to join a chat or channel (bots only, users will receive an , instead) See The chat or channel in question When was the join request » made The user ID that is asking to join the chat or channel Bio of the user Chat invite link that was used by the user to send the join request » QTS event sequence identifier New message reactions » are available See Extra bits of information, use flags.HasFlag(...) to test for those Peer Message ID Forum topic ID Reactions Field has a value The list of installed attachment menu entries » has changed, use Messages_GetAttachMenuBots to fetch the updated list. See Indicates to a bot that a webview was closed and an inline message was sent on behalf of the user using Messages_SendWebViewResultMessage See Web app interaction ID The menu button behavior for the specified bot has changed See Bot ID New menu button The list of saved notification sounds has changed, use Account_GetSavedRingtones to fetch the new list. See A pending voice message transcription » initiated with Messages_TranscribeAudio was updated. See Extra bits of information, use flags.HasFlag(...) to test for those Peer of the transcribed message Transcribed message ID Transcription ID Transcribed text Whether this transcription is still pending and further about it will be sent in the future. Some featured custom emoji stickers were marked as read See The emoji status of a certain user has changed See New emoji status The list of recent emoji statuses has changed See The list of recent message reactions has changed See A stickerset was just moved to top, see here for more info » See Extra bits of information, use flags.HasFlag(...) to test for those Stickerset ID This update is referring to a mask stickerset This update is referring to a custom emoji stickerset You bought a paid media »: this update contains the revealed media. See Peer where the paid media was posted ID of the message containing the paid media Revealed media, contains only s. A forum topic » was pinned or unpinned. See Extra bits of information, use flags.HasFlag(...) to test for those The forum ID The topic ID Whether the topic was pinned or unpinned The pinned topics of a forum have changed. See Extra bits of information, use flags.HasFlag(...) to test for those Forum ID. Ordered list containing the IDs of all pinned topics. Field has a value User ( and/or ) information was updated. See User ID Media autosave settings have changed and must be refetched using Account_GetAutoSaveSettings. See A new story was posted. See ID of the poster. The story that was posted. Stories of a specific peer were marked as read. See The peer ID of the last story that was marked as read A story was successfully uploaded. See The id that was attributed to the story. The random_id that was passed to Stories_SendStory. Indicates that stories stealth mode was activated. See Information about the current stealth mode session. Indicates we reacted to a story ». See The peer that sent the story ID of the story we reacted to The reaction that was sent A channel/supergroup boost has changed (bots only) See Channel New boost information QTS event sequence identifier Users may also choose to display messages from all topics as if they were sent to a normal group, using a "View as messages" setting in the local client.
This setting only affects the current account, and is synced to other logged in sessions using the Channels_ToggleViewForumAsMessages method; invoking this method will update the value of the view_forum_as_messages flag of or and emit an . See The new value of the toggle. The wallpaper » of a given peer has changed. See Extra bits of information, use flags.HasFlag(...) to test for those The peer where the wallpaper has changed. The new wallpaper, if none the wallpaper was removed and the default wallpaper should be used. Field has a value Whether the other user has chosen a custom wallpaper for us using Messages_SetChatWallPaper and the for_both flag, see here » for more info. Bots only: a user has changed their reactions on a message with public reactions. See Peer of the reacted-to message. ID of the reacted-to message. Date of the change. The user that (un)reacted to the message. Old reactions New reactions QTS event sequence identifier Bots only: the number of reactions on a message with anonymous reactions has changed. See Peer of the reacted-to message. ID of the reacted-to message. Date of the change. New reaction counters. QTS event sequence identifier A saved message dialog was pinned/unpinned See Extra bits of information, use flags.HasFlag(...) to test for those The dialog Whether the dialog was pinned Pinned saved dialogs » were updated See Extra bits of information, use flags.HasFlag(...) to test for those New order of pinned saved dialogs Field has a value The list of reaction tag » names assigned by the user has changed and should be refetched using Messages_GetSavedReactionTags. See A new SMS job was received See SMS job ID Info about or the order of quick reply shortcuts » was changed. See New quick reply shortcut order and information. A new quick reply shortcut » was created. See Quick reply shortcut. A quick reply shortcut » was deleted. This will not emit updates, even if all the messages in the shortcut are also deleted by this update. See ID of the quick reply shortcut that was deleted. A new message was added to a quick reply shortcut ». See The message that was added (the .quick_reply_shortcut_id field will contain the shortcut ID). One or more messages in a quick reply shortcut » were deleted. See IDs of the deleted messages. Connecting or disconnecting a business bot or changing the connection settings will emit an update to the bot, with the new settings and a connection_id that will be used by the bot to handle updates from and send messages as the user. See Business connection settings New qts value, see updates » for more info. A message was received via a connected business chat ». See Extra bits of information, use flags.HasFlag(...) to test for those Connection ID. New message. The message that message is replying to. New qts value, see updates » for more info. Field has a value A message was edited in a connected business chat ». See Extra bits of information, use flags.HasFlag(...) to test for those Business connection ID New message. The message that message is replying to. New qts value, see updates » for more info. Field has a value A message was deleted in a connected business chat ». See Business connection ID. Peer where the messages were deleted. IDs of the messages that were deleted. New qts value, see updates » for more info. Represents a new reaction to a story. See Story ID. The peer where the story was posted. The reaction. A new channel ad revenue transaction was made, see here » for more info. See Channel New ad revenue balance. The current account's Telegram Stars balance » has changed. See New balance. A callback button sent via a business connection was pressed, and the button data was sent to the bot that created the button. See Extra bits of information, use flags.HasFlag(...) to test for those Query ID ID of the user that pressed the button Business connection ID Message that contains the keyboard (also contains info about the chat where the message was sent). The message that message is replying to. Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. Callback data Field has a value Field has a value The Telegram Star balance of a channel/bot we own has changed ». See Channel/bot New Telegram Star balance. Bots only: a user has purchased a paid media. See The user that bought the media Payload passed by the bot in .payload New qts value, see updates » for more info. Contains the current default paid reaction privacy, see here » for more info. See Whether paid reaction privacy is enabled or disabled. Updates state. See Number of events occurred in a text box Position in a sequence of updates in secret chats. For further details refer to article secret chats Date of condition Number of sent updates Number of unread messages Occurred changes. See Derived classes: , , , List of new messages List of new encrypted secret chat messages List of updates returns a or for the given Peer No events. See Current date Number of sent updates returns a or for the given Peer Full list of occurred events. See List of new messages List of new encrypted secret chat messages List of updates List of chats mentioned in events List of users mentioned in events Current state List of new messages List of new encrypted secret chat messages List of updates returns a or for the given Peer Incomplete list of occurred events. See List of new messages New messages from the encrypted event sequence List of updates List of chats mentioned in events List of users mentioned in events Intermediary state List of new messages New messages from the encrypted event sequence List of updates returns a or for the given Peer The difference is too long, and the specified state must be used to refetch updates. See The new state to use. returns a or for the given Peer Object which is perceived by the client without a call on its part when an event occurs. See Derived classes: , , , , , , date returns a or for the given Peer Too many updates, it is necessary to execute Updates_GetDifference. See returns a or for the given Peer Info about a message sent to (received from) another user See Extra bits of information, use flags.HasFlag(...) to test for those The message ID The ID of the sender (if outgoing will be the ID of the destination) of the message The message PTS PTS count date Info about a forwarded message Info about the inline bot used to generate this message Reply and thread information Entities for styled text Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Whether the message is outgoing Field has a value Field has a value Whether we were mentioned in the message Whether there are some unread mentions in this message Field has a value Field has a value If true, the message is a silent message, no notifications should be triggered Field has a value date returns a or for the given Peer Shortened constructor containing info on one new incoming text message from a chat See Extra bits of information, use flags.HasFlag(...) to test for those ID of the message ID of the sender of the message ID of the chat where the message was sent Message PTS PTS count date Info about a forwarded message Info about the inline bot used to generate this message Reply (thread) information Entities for styled text Time To Live of the message, once updateShortChatMessage.date+updateShortChatMessage.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Whether the message is outgoing Field has a value Field has a value Whether we were mentioned in this message Whether the message contains some unread mentions Field has a value Field has a value If true, the message is a silent message, no notifications should be triggered Field has a value date returns a or for the given Peer Shortened constructor containing info on one update not requiring auxiliary data See Update Date of event Date of event returns a or for the given Peer Constructor for a group of updates. See List of updates List of users mentioned in updates List of chats mentioned in updates Current date Value seq for the earliest update in a group Value seq for the latest update in a group Current date returns a or for the given Peer Full constructor of updates See List of updates List of users mentioned in updates List of chats mentioned in updates Current date Total number of sent updates Current date returns a or for the given Peer Shortened constructor containing info on one outgoing message to a contact (the destination chat has to be extracted from the method call that returned this object). See Extra bits of information, use flags.HasFlag(...) to test for those ID of the sent message PTS PTS count date Attached media Entities for styled text Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. Whether the message is outgoing Field has a value Field has a value Field has a value date returns a or for the given Peer Full list of photos with auxiliary data. See List of photos List of mentioned users Incomplete list of photos with auxiliary data. See Total number of photos Photo with auxiliary data. See Photo Users Contains info on file. See Derived classes: , File content. See File type Modification time Binary data, file content The file must be downloaded from a CDN DC. See CDN DC ID File token (see CDN files) Encryption key (see CDN files) Encryption IV (see CDN files) File hashes (see CDN files) Data center See Extra bits of information, use flags.HasFlag(...) to test for those DC ID IP address of DC Port If the tcpo_only flag is set, specifies the secret to use when connecting using transport obfuscation Whether the specified IP is an IPv6 address Whether this DC should only be used to download or upload files Whether this DC only supports connection with transport obfuscation Whether this is a CDN DC. If set, this IP should be used when connecting through a proxy If set, clients must connect using only the specified port, without trying any other port. Field has a value Current configuration See Extra bits of information, use flags.HasFlag(...) to test for those Current date at the server Expiration date of this config: when it expires it'll have to be refetched using Help_GetConfig Whether we're connected to the test DCs ID of the DC that returned the reply DC IP list Domain name for fetching encrypted DC list from DNS TXT record Maximum member count for normal groups Maximum member count for supergroups Maximum number of messages that can be forwarded at once using Messages_ForwardMessages. The client should Account_UpdateStatus every N milliseconds Delay before offline status needs to be sent to the server Time without any user activity after which it should be treated offline If we are offline, but were online from some other client in last online_cloud_timeout_ms milliseconds after we had gone offline, then delay offline notification for notify_cloud_delay_ms milliseconds. If we are offline, but online from some other client then delay sending the offline notification for notify_cloud_delay_ms milliseconds. If some other client is online, then delay notification for notification_default_delay_ms milliseconds Not for client use Not for client use Only messages with age smaller than the one specified can be edited Only channel/supergroup messages with age smaller than the specified can be deleted Only private messages with age smaller than the specified can be deleted Exponential decay rate for computing top peer rating Maximum number of recent stickers Indicates that round videos (video notes) and voice messages sent in channels and older than the specified period must be marked as read Temporary passport sessions Maximum allowed outgoing ring time in VoIP calls: if the user we're calling doesn't reply within the specified time (in milliseconds), we should hang up the call Maximum allowed incoming ring time in VoIP calls: if the current user doesn't reply within the specified time (in milliseconds), the call will be automatically refused VoIP connection timeout: if the instance of libtgvoip on the other side of the call doesn't connect to our instance of libtgvoip within the specified time (in milliseconds), the call must be aborted If during a VoIP call a packet isn't received for the specified period of time, the call must be aborted The domain to use to parse deep links ». URL to use to auto-update the current app Username of the bot to use to search for GIFs Username of the bot to use to search for venues Username of the bot to use for image search ID of the map provider to use for venues Maximum length of caption (length in utf8 codepoints) Maximum length of messages (length in utf8 codepoints) DC ID to use to download webfiles Suggested language code Language pack version Basic language pack version Default message reaction Autologin token, click here for more info on URL authorization ». Field has a value Fields , and have a value Whether the client should use P2P by default for phone calls with contacts Whether the client should preload featured stickers Whether incoming private messages can be deleted for both participants Field has a value Indicates that telegram is probably censored by governments/ISPs in the current region Field has a value Field has a value Field has a value Field has a value Whether to forcefully connect using IPv6 , even if the client knows that IPv4 is available. Field has a value Field has a value Nearest data center, according to geo-ip. See Country code determined by geo-ip Number of current data center Number of nearest data center An update is available for the application. See a value means help.noAppUpdate Extra bits of information, use flags.HasFlag(...) to test for those Update ID New version name Text description of the update Message entities for styled text Application binary Application download URL Associated sticker Unskippable, the new info must be shown to the user (with a popup or something else) Field has a value Field has a value Field has a value Text of a text message with an invitation to install Telegram. See Text of the message Object contains info on an encrypted chat. See Derived classes: , , , , Chat ID Checking sum depending on user ID Date of chat creation Chat creator ID ID of second chat participant Empty constructor. See Chat ID Chat ID Chat waiting for approval of second participant. See Chat ID Checking sum depending on user ID Date of chat creation Chat creator ID ID of second chat participant Chat ID Checking sum depending on user ID Date of chat creation Chat creator ID ID of second chat participant Request to create an encrypted chat. See Extra bits of information, use flags.HasFlag(...) to test for those Peer folder ID, for more info click here Chat ID Check sum depending on user ID Chat creation date Chat creator ID ID of second chat participant A = g ^ a mod p, see Wikipedia Field has a value Chat ID Check sum depending on user ID Chat creation date Chat creator ID ID of second chat participant Encrypted chat See Chat ID Check sum dependent on the user ID Date chat was created Chat creator ID ID of the second chat participant B = g ^ b mod p, if the currently authorized user is the chat's creator,
or A = g ^ a mod p otherwise
See Wikipedia for more info 64-bit fingerprint of received key Chat ID Check sum dependent on the user ID Date chat was created Chat creator ID ID of the second chat participant Discarded or deleted chat. See Extra bits of information, use flags.HasFlag(...) to test for those Chat ID Whether both users of this secret chat should also remove all of its messages Chat ID Creates an encrypted chat. See Chat ID ⚠ REQUIRED FIELD. See how to obtain it
Checking sum from constructor , or Encrypted file. See a value means encryptedFileEmpty File ID Checking sum depending on user ID File size in bytes Number of data center 32-bit fingerprint of key used for file encryption Object sets encrypted file for attachment See Derived classes: , , a value means inputEncryptedFileEmpty Random file ID created by client Sets new encrypted file saved by parts using upload.saveFilePart method. See Random file ID created by client Number of saved parts In case md5-HASH of the (already encrypted) file was transmitted, file content will be checked prior to use 32-bit fingerprint of the key used to encrypt a file Random file ID created by client Sets forwarded encrypted file for attachment. See File ID, value of id parameter from ⚠ REQUIRED FIELD. See how to obtain it
Checking sum, value of access_hash parameter from File ID, value of id parameter from Assigns a new big encrypted file (over 10 MB in size), saved in parts using the method Upload_SaveBigFilePart. See Random file id, created by the client Number of saved parts 32-bit imprint of the key used to encrypt the file Random file id, created by the client Object contains encrypted message. See Derived classes: , Random message ID, assigned by the author of message ID of encrypted chat Date of sending TL-serialization of type, encrypted with the key created at chat initialization Encrypted message. See Random message ID, assigned by the author of message ID of encrypted chat Date of sending TL-serialization of type, encrypted with the key created at chat initialization Attached encrypted file Random message ID, assigned by the author of message ID of encrypted chat Date of sending TL-serialization of type, encrypted with the key created at chat initialization Encrypted service message See Random message ID, assigned by the author of message ID of encrypted chat Date of sending TL-serialization of the type, encrypted with the key created at chat initialization Random message ID, assigned by the author of message ID of encrypted chat Date of sending TL-serialization of the type, encrypted with the key created at chat initialization Contains Diffie-Hellman key generation protocol parameters. See Derived classes: , Configuring parameters did not change. See Random sequence of bytes of assigned length New set of configuring parameters. See New value prime, see Wikipedia New value primitive root, see Wikipedia Version of set of parameters Random sequence of bytes of assigned length Message without file attachments sent to an encrypted file. See Date of sending Message with a file enclosure sent to a protected chat See Attached file Defines a document for subsequent interaction. See a value means inputDocumentEmpty Document ID ⚠ REQUIRED FIELD. See how to obtain it
access_hash parameter from the File reference A document. See Derived classes: , Empty constructor, document doesn't exist. See Document ID or 0 Document See Extra bits of information, use flags.HasFlag(...) to test for those Document ID Check sum, dependent on document ID File reference Creation date MIME type Size Thumbnails Video thumbnails DC ID Attributes Field has a value Field has a value Info on support user. See Phone number User Object defines the set of users and/or groups that generate notifications. See Derived classes: , , , , Notifications generated by a certain user or group. See user or group Notifications generated by all users. See Notifications generated by all groups. See Channel notification settings See Notifications generated by a topic in a forum. See Forum ID Topic ID User actions. Use this to provide users with detailed info about their chat partner's actions: typing or sending attachments of all kinds. See Derived classes: , , , , , , , , , , , , , , , , , User is typing. See Invalidate all previous action updates. E.g. when user deletes entered text or aborts a video upload. See User is recording a video. See User is uploading a video. See Progress percentage User is recording a voice message. See User is uploading a voice message. See Progress percentage User is uploading a photo. See Progress percentage User is uploading a file. See Progress percentage User is selecting a location to share. See User is selecting a contact to share. See User is playing a game See User is recording a round video to share See User is uploading a round video See Progress percentage User is currently speaking in the group call See Chat history is being imported See Progress percentage User is choosing a sticker See User has clicked on an animated emoji triggering a reaction, click here for more info ». See Emoji Message ID of the animated emoji that was clicked A JSON object with interaction info, click here for more info » User is watching an animated emoji reaction triggered by another user, click here for more info ». See Emoji Users found by name substring and auxiliary data. See Personalized results List of found user identifiers Found chats List of users returns a or for the given Peer Privacy keys together with privacy rules » indicate what can or can't someone do and are specified by a constructor, and its input counterpart . See Whether people will be able to see our exact last online timestamp.

Note that if we decide to hide our exact last online timestamp to someone (i.e., users A, B, C, or all users) and we do not have a Premium subscription, we won't be able to see the exact last online timestamp of those users (A, B, C, or all users), even if those users do share it with us.

If those users do share their exact online status with us, but we can't see it due to the reason mentioned above, the by_me flag of , , will be set. Whether people will be able to invite you to chats Whether you will accept phone calls Whether to allow P2P communication during VoIP calls Whether messages forwarded from you will be anonymous Whether people will be able to see your profile picture Whether people will be able to see your phone number Whether people can add you to their contact list by your phone number Whether people can send you voice messages or round videos (Premium users only). Whether people can see your bio Whether the user can see our birthday. See Privacy keys together with privacy rules » indicate what can or can't someone do and are specified by a constructor, and its input counterpart . See Whether we can see the last online timestamp of this user.

Note that if we decide to hide our exact last online timestamp to someone (i.e., users A, B, C, or all users) and we do not have a Premium subscription, we won't be able to see the exact last online timestamp of those users (A, B, C, or all users), even if those users do share it with us.

If those users do share their exact online status with us, but we can't see it due to the reason mentioned above, the by_me flag of , , will be set. Whether the user can be invited to chats Whether the user accepts phone calls Whether P2P connections in phone calls with this user are allowed Whether messages forwarded from the user will be anonymously forwarded Whether the profile picture of the user is visible Whether the user allows us to see his phone number Whether this user can be added to our contact list by their phone number Whether the user accepts voice messages Whether people can see your bio Whether the user can see our birthday. See Privacy rules indicate who can or can't do something and are specified by a , and its input counterpart . See Derived classes: , , , , , , , , , Allow only contacts See Allow all users See Allow only certain users See Allowed users Disallow only contacts See Disallow all See Disallow only certain users See Users to disallow Allow only participants of certain chats See Allowed chat IDs Disallow only participants of certain chats See Disallowed chat IDs Allow only close friends » See Allow only users with a Premium subscription », currently only usable for . See See See Privacy rules together with privacy keys indicate what can or can't someone do and are specified by a constructor, and its input counterpart . See Derived classes: , , , , , , , , , Allow all contacts See Allow all users See Allow only certain users See Allowed users Disallow only contacts See Disallow all users See Disallow only certain users See Disallowed users Allow all participants of certain chats See Allowed chats Disallow only participants of certain chats See Disallowed chats Allow only close friends » See Allow only users with a Premium subscription », currently only usable for . See See See Privacy rules See Privacy rules Chats to which the rules apply Users to which the rules apply returns a or for the given Peer Time to live in days of the current account See This account will self-destruct in the specified number of days Various possible attributes of a document (used to define if it's a sticker, a GIF, a video, a mask sticker, an image, an audio, and so on) See Derived classes: , , , , , , , Defines the width and height of an image uploaded as document See Width of image Height of image Defines an animated GIF See Defines a sticker See Extra bits of information, use flags.HasFlag(...) to test for those Alternative emoji representation of sticker Associated stickerset Mask coordinates (if this is a mask sticker, attached to a photo) Field has a value Whether this is a mask sticker Defines a video See Extra bits of information, use flags.HasFlag(...) to test for those Duration in seconds Video width Video height Number of bytes to preload when preloading videos (particularly video stories). Floating point UNIX timestamp in seconds, indicating the frame of the video that should be used as static preview and thumbnail. Codec used for the video, i.e. "h264", "h265", or "av1" Whether this is a round video Whether the video supports streaming Field has a value Whether the specified document is a video file with no audio tracks (a GIF animation (even as MPEG4), for example) Field has a value Field has a value Represents an audio file See Extra bits of information, use flags.HasFlag(...) to test for those Duration in seconds Name of song Performer Waveform: consists in a series of bitpacked 5-bit values.
Example implementation: android. Field has a value Field has a value Field has a value Whether this is a voice message A simple document with a file name See The file name Whether the current document has stickers attached See Info about a custom emoji See Extra bits of information, use flags.HasFlag(...) to test for those The actual emoji The emoji stickerset to which this emoji belongs. Whether this custom emoji can be sent by non-Premium users Whether the color of this TGS custom emoji should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context. Found stickers See a value means messages.stickersNotModified Hash used for caching, for more info click here Stickers A stickerpack is a group of stickers associated to the same emoji.
It is not a sticker pack the way it is usually intended, you may be looking for a . See Emoji Stickers Info about all installed stickers See a value means messages.allStickersNotModified Hash used for caching, for more info click here All stickersets Events affected by operation See Event count after generation Number of events that were generated Instant View webpage preview See Derived classes: , , , Preview ID URL of the webpage. No preview is available for the webpage See Extra bits of information, use flags.HasFlag(...) to test for those Preview ID URL of the webpage. Field has a value Preview ID URL of the webpage. A preview of the webpage is currently being generated See Extra bits of information, use flags.HasFlag(...) to test for those ID of preview URL of the webpage When was the processing started Field has a value ID of preview URL of the webpage Webpage preview See Extra bits of information, use flags.HasFlag(...) to test for those Preview ID URL of previewed webpage Webpage URL to be displayed to the user Hash used for caching, for more info click here Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else, see here » for a full list. Short name of the site (e.g., Google Docs, App Store) Title of the content Content description Image representing the content URL to show in the embedded preview MIME type of the embedded preview, (e.g., text/html or video/mp4) Width of the embedded preview Height of the embedded preview Duration of the content, in seconds Author of the content Preview of the content as a media file Page contents in instant view format Webpage attributes Field has a value Field has a value Field has a value Field has a value Field has a value Fields and have a value Fields and have a value Field has a value Field has a value Field has a value Field has a value Field has a value Whether the size of the media in the preview can be changed. Preview ID URL of previewed webpage The preview of the webpage hasn't changed See Extra bits of information, use flags.HasFlag(...) to test for those Page view count Field has a value Logged-in session See Extra bits of information, use flags.HasFlag(...) to test for those Identifier Device model Platform System version API ID App name App version When was the session created When was the session last active Last known IP Country determined from IP Region determined from IP Whether this is the current session Whether the session is from an official app Whether the session is still waiting for a 2FA password Whether this session will accept encrypted chats Whether this session will accept phone calls Whether the session is unconfirmed, see here » for more info. Logged-in sessions See Time-to-live of session Logged-in sessions Configuration for two-factor authorization See Extra bits of information, use flags.HasFlag(...) to test for those The KDF algorithm for SRP two-factor authentication of the current password Srp B param for SRP authorization Srp ID param for SRP authorization Text hint for the password A password recovery email with the specified pattern is still awaiting verification The KDF algorithm for SRP two-factor authentication to use when creating new passwords The KDF algorithm for telegram passport Secure random string The 2FA password will be automatically removed at this date, unless the user cancels the operation A verified login email with the specified pattern is configured Whether the user has a recovery method configured Whether telegram passport is enabled Whether the user has a password Field has a value Field has a value Field has a value Field has a value Private info associated to the password info (recovery email, telegram passport info & so on) See Extra bits of information, use flags.HasFlag(...) to test for those 2FA Recovery email Telegram passport settings Field has a value Field has a value Settings for setting up a new password See Extra bits of information, use flags.HasFlag(...) to test for those The SRP algorithm to use The computed password hash Text hint for the password Password recovery email Telegram passport settings Fields , and have a value Field has a value Field has a value Recovery info of a 2FA password, only for accounts with a recovery email configured. See The email to which the recovery code was sent must match this pattern. Message ID, for which PUSH-notifications were cancelled. See Message ID, for which PUSH-notifications were canceled Reserved for future use Exported chat invite See Derived classes: , Exported chat invite See Extra bits of information, use flags.HasFlag(...) to test for those Chat invitation link ID of the admin that created this chat invite When was this chat invite created When was this chat invite last modified When does this chat invite expire Maximum number of users that can join using this link How many users joined using this link Number of users that have already used this link to join For Telegram Star subscriptions », contains the number of chat members which have already joined the chat using the link, but have already left due to expiration of their subscription. Custom description for the invite link, visible only to admins For Telegram Star subscriptions », contains the pricing of the subscription the user must activate to join the private channel. Whether this chat invite was revoked Field has a value Field has a value Field has a value Field has a value Whether this chat invite has no expiration Whether users importing this invite link will have to be approved to join the channel or group Field has a value Field has a value Field has a value Field has a value Used in updates and in the channel log to indicate when a user is requesting to join or has joined a discussion group See Chat invite See Derived classes: , , The user has already joined this chat See The chat connected to the invite Chat invite info See Extra bits of information, use flags.HasFlag(...) to test for those Chat/supergroup/channel title Description of the group of channel Chat/supergroup/channel photo Participant count A few of the participants that are in the group Profile color palette ID For Telegram Star subscriptions », contains the pricing of the subscription the user must activate to join the private channel. For Telegram Star subscriptions », the ID of the payment form for the subscription. Whether this is a channel/supergroup or a normal group Whether this is a channel Whether this is a public channel/supergroup Whether this is a supergroup Field has a value Field has a value Whether the join request » must be first approved by an administrator Is this chat or channel verified by Telegram? This chat is probably a scam If set, this chat was reported by many users as a fake or scam: be careful when interacting with it. Field has a value If set, indicates that the user has already paid for the associated Telegram Star subscriptions » and it hasn't expired yet, so they may re-join the channel using Messages_ImportChatInvite without repeating the payment. Field has a value A chat invitation that also allows peeking into the group to read messages without joining it. See Chat information Read-only anonymous access to this group will be revoked at this date Represents a stickerset See Derived classes: , , , , , , , , , a value means inputStickerSetEmpty Stickerset by ID See ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash Stickerset by short name, from a stickerset deep link » See Short name from a stickerset deep link » Animated emojis stickerset See Used for fetching animated dice stickers See The emoji, for now 🏀, 🎲 and 🎯 are supported Animated emoji reaction stickerset (contains animations to play when a user clicks on a given animated emoji) See Stickers to show when receiving a gifted Telegram Premium subscription See Generic animation stickerset containing animations to play when reacting to messages using a normal emoji without a custom animation See Default custom emoji status stickerset See Default custom emoji stickerset for forum topic icons See Default custom emoji status stickerset for channel statuses See Represents a stickerset (stickerpack) See Extra bits of information, use flags.HasFlag(...) to test for those When was this stickerset installed ID of the stickerset Access hash of stickerset Title of stickerset Short name of stickerset, used when sharing stickerset using stickerset deep links. Stickerset thumbnail DC ID of thumbnail Thumbnail version Document ID of custom emoji thumbnail, fetch the document using Messages_GetCustomEmojiDocuments Number of stickers in pack Hash Field has a value Whether this stickerset was archived (due to too many saved stickers in the current account) Is this stickerset official Is this a mask stickerset Fields , and have a value This is a custom emoji stickerset Field has a value Whether the color of this TGS custom emoji stickerset should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context. If set, this custom emoji stickerset can be used in channel/supergroup emoji statuses. Whether we created this stickerset Stickerset and stickers inside it See a value means messages.stickerSetNotModified The stickerset Emoji info for stickers Keywords for some or every sticker in the stickerset. Stickers in stickerset Describes a bot command that can be used in a chat See /command name Description of the command Info about bots (available bot commands, etc) See Extra bits of information, use flags.HasFlag(...) to test for those ID of the bot Description of the bot Description photo Description animation in MPEG4 format Bot commands that can be used in the chat Indicates the action to execute when pressing the in-UI menu button for bots The HTTP link to the privacy policy of the bot. If not set, then the /privacy command must be used, if supported by the bot (i.e. if it's present in the commands vector). If it isn't supported, then https://telegram.org/privacy-tpa must be opened, instead. Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value If set, the bot has some preview medias for the configured Main Mini App, see here » for more info on Main Mini App preview medias. Field has a value Field has a value Bot or inline keyboard buttons See Derived classes: , , , , , , , , , , , , , , , , , Button text Bot keyboard button See Button text Button text URL button See URL Callback button See Extra bits of information, use flags.HasFlag(...) to test for those Button text Callback data Whether the user should verify his identity by entering his 2FA SRP parameters to the Messages_GetBotCallbackAnswer method. NOTE: telegram and the bot WILL NOT have access to the plaintext password, thanks to SRP. This button is mainly used by the official @botfather bot, for verifying the user's identity before transferring ownership of a bot to another user. Button text Button to request a user's phone number See Button to request a user's geolocation See Button to force a user to switch to inline mode: pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. See Extra bits of information, use flags.HasFlag(...) to test for those Button label The inline query to use Filter to use when selecting chats. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Field has a value Button label Button to start a game See Button to buy a product See Button to request a user to authorize via URL using Seamless Telegram Login. When the user clicks on such a button, Messages_RequestUrlAuth should be called, providing the button_id and the ID of the container message. The returned object will contain more details about the authorization request (request_write_access if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call Messages_AcceptUrlAuth to get a with the URL to open instead of the url of this constructor, or a , in which case the url of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the url of this constructor must be used. See Extra bits of information, use flags.HasFlag(...) to test for those Button label New text of the button in forwarded messages. An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.

NOTE: Services must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization. ID of the button to pass to Messages_RequestUrlAuth Field has a value Button label Button to request a user to Messages_AcceptUrlAuth via URL using Seamless Telegram Login. See Extra bits of information, use flags.HasFlag(...) to test for those Button text New text of the button in forwarded messages. An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.
NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details. Set this flag to request the permission for your bot to send messages to the user. Field has a value Button text A button that allows the user to create and send a poll when pressed; available only in private See Extra bits of information, use flags.HasFlag(...) to test for those If set, only quiz polls can be sent Field has a value Button that links directly to a user profile See Button text User ID Button text Button that links directly to a user profile See User ID Button to open a bot mini app using Messages_RequestWebView, sending over user information after user confirmation. See Web app url Button to open a bot mini app using Messages_RequestSimpleWebView, without sending user information to the web app. See Prompts the user to select and share one or more peers with the bot using Messages_SendBotRequestedPeer See Button ID, to be passed to Messages_SendBotRequestedPeer. Filtering criteria to use for the peer selection list shown to the user.
The list should display all existing peers of the specified type, and should also offer an option for the user to create and immediately use one or more (up to max_quantity) peers of the specified type, if needed. Maximum number of peers that can be chosen. Prompts the user to select and share one or more peers with the bot using Messages_SendBotRequestedPeer. See Extra bits of information, use flags.HasFlag(...) to test for those Button text Button ID, to be passed to Messages_SendBotRequestedPeer. Filtering criteria to use for the peer selection list shown to the user.
The list should display all existing peers of the specified type, and should also offer an option for the user to create and immediately use one or more (up to max_quantity) peers of the specified type, if needed. Maximum number of peers that can be chosen. Set this flag to request the peer's name. Set this flag to request the peer's @username (if any). Set this flag to request the peer's photo (if any). Button text Clipboard button: when clicked, the attached text must be copied to the clipboard. See The text that will be copied to the clipboard Inline keyboard row See Bot or inline keyboard buttons Reply markup for bot and inline keyboards See Derived classes: , , , Hide sent bot keyboard See Extra bits of information, use flags.HasFlag(...) to test for those Use this flag if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet Force the user to send a reply See Extra bits of information, use flags.HasFlag(...) to test for those The placeholder to be shown in the input field when the keyboard is active; 1-64 characters. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. Field has a value Bot keyboard See Extra bits of information, use flags.HasFlag(...) to test for those Button row The placeholder to be shown in the input field when the keyboard is active; 1-64 characters. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). If not set, the custom keyboard is always of the same height as the app's standard keyboard. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. Field has a value Requests clients to always show the keyboard when the regular keyboard is hidden. Bot or inline keyboard See Bot or inline keyboard rows Message entities, representing styled text in a message See Derived classes: , , , , , , , , , , , , , , , , , , , , Offset of message entity within message (in UTF-16 code units) Length of message entity within message (in UTF-16 code units) Unknown message entity See Message entity mentioning a user by @username; can also be used to mention users by their ID. See #hashtag message entity See Message entity representing a bot /command See Message entity representing an in-text url: https://google.com; for text urls, use . See Message entity representing an email@example.com. See Message entity representing bold text. See Message entity representing italic text. See Message entity representing a codeblock. See Message entity representing a preformatted codeblock, allowing the user to specify a programming language for the codeblock. See Programming language of the code Message entity representing a text url: for in-text urls like https://google.com use . See The actual URL Message entity representing a user mention: for creating a mention use . See Identifier of the user that was mentioned Message entity that can be used to create a user user mention: received mentions use the , instead. See Identifier of the user that was mentioned Message entity representing a phone number. See Message entity representing a $cashtag. See Message entity representing underlined text. See Message entity representing strikethrough text. See Indicates a credit card number See Message entity representing a spoiler See Represents a custom emoji.
Note that this entity must wrap exactly one regular emoji (the one contained in .alt) in the related text, otherwise the server will ignore it. See Document ID of the custom emoji, use Messages_GetCustomEmojiDocuments to fetch the emoji animation and the actual emoji it represents. Message entity representing a block quote. See Extra bits of information, use flags.HasFlag(...) to test for those Whether the quote is collapsed by default. Represents a channel See Derived classes: , a value means inputChannelEmpty Channel ID Represents a channel See Channel ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash taken from the Channel ID Channel identifier ⚠ REQUIRED FIELD. See FAQ for how to obtain it
access_hash value from the structure Defines a min channel that was seen in a certain message of a certain chat. See The chat where the channel was seen The message ID in the chat where the channel was seen The channel ID The channel ID Resolved peer See The peer Chats Users returns a or for the result A , or if the username was for a channel A or , or if the username was for a user A , or if the username was for a user or for a forbidden channel Indicates a range of chat messages See Start of range (message ID) End of range (message ID) Contains the difference (new messages) between our local channel state and the remote state See Derived classes: , , returns a or for the given Peer There are no new updates See Extra bits of information, use flags.HasFlag(...) to test for those The latest PTS Clients are supposed to refetch the channel difference after timeout seconds have elapsed, if the user is currently viewing the chat, see here » for more info. Whether there are more updates that must be fetched (always false) Field has a value returns a or for the given Peer The provided pts + limit < remote pts. Simply, there are too many updates to be fetched (more than limit), the client has to resolve the update gap in one of the following ways (assuming the existence of a persistent database to locally store messages): See Extra bits of information, use flags.HasFlag(...) to test for those Clients are supposed to refetch the channel difference after timeout seconds have elapsed Dialog containing the latest PTS that can be used to reset the channel state The latest messages Chats from messages Users from messages Whether there are more updates that must be fetched (always false) Field has a value returns a or for the given Peer The new updates See Extra bits of information, use flags.HasFlag(...) to test for those The PTS from which to start getting updates the next time Clients are supposed to refetch the channel difference after timeout seconds have elapsed, if the user is currently viewing the chat, see here » for more info. New messages Other updates Chats Users Whether there are more updates to be fetched using getDifference, starting from the provided pts Field has a value returns a or for the given Peer Filter for getting only certain types of channel messages See a value means channelMessagesFilterEmpty Extra bits of information, use flags.HasFlag(...) to test for those A range of messages to fetch Whether to exclude new messages from the search Channel participant See Derived classes: , , , , , Channel/supergroup participant See Extra bits of information, use flags.HasFlag(...) to test for those Participant user ID Date joined If set, contains the expiration date of the current Telegram Star subscription period » for the specified participant. Field has a value Myself See Extra bits of information, use flags.HasFlag(...) to test for those User ID User that invited me to the channel/supergroup When did I join the channel/supergroup If set, contains the expiration date of the current Telegram Star subscription period » for the specified participant. Whether I joined upon specific approval of an admin Field has a value Channel/supergroup creator See Extra bits of information, use flags.HasFlag(...) to test for those User ID Creator admin rights The role (rank) of the group creator in the group: just an arbitrary string, admin by default Field has a value Admin See Extra bits of information, use flags.HasFlag(...) to test for those Admin user ID User that invited the admin to the channel/group User that promoted the user to admin When did the user join Admin rights The role (rank) of the admin in the group: just an arbitrary string, admin by default Can this admin promote other admins with the same permissions? Is this the current user Field has a value Banned/kicked user See Extra bits of information, use flags.HasFlag(...) to test for those The banned peer User was kicked by the specified admin When did the user join the group Banned rights Whether the user has left the group A participant that left the channel/supergroup See The peer that left Filter for fetching channel participants See Derived classes: , , , , , , , Fetch only recent participants See Fetch only admin participants See Fetch only kicked participants See Optional filter for searching kicked participants by name (otherwise empty) Fetch only bot participants See Fetch only banned participants See Optional filter for searching banned participants by name (otherwise empty) Query participants by name See Search query Fetch only participants that are also contacts See Optional search query for searching contact participants by name This filter is used when looking for supergroup members to mention.
This filter will automatically remove anonymous admins, and return even non-participant users that replied to a specific thread through the comment section of a channel. See Extra bits of information, use flags.HasFlag(...) to test for those Filter by user name or username Look only for users that posted in this thread Field has a value Field has a value Represents multiple channel participants See a value means channels.channelParticipantsNotModified Total number of participants that correspond to the given query Participants Mentioned chats Users mentioned in participant info returns a or for the given Peer Represents a channel participant See The channel participant Mentioned chats Users returns a or for the given Peer Info about the latest telegram Terms Of Service See Extra bits of information, use flags.HasFlag(...) to test for those ID of the new terms Text of the new terms Message entities for styled text Minimum age required to sign up to telegram, the user must confirm that they is older than the minimum age. Whether a prompt must be showed to the user, in order to accept the new terms. Field has a value Saved gifs See a value means messages.savedGifsNotModified Hash used for caching, for more info click here List of saved gifs Represents a sent inline message from the perspective of a bot See Derived classes: , , , , , , , A media See Extra bits of information, use flags.HasFlag(...) to test for those Caption Message entities for styled text Inline keyboard Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Simple text message See Extra bits of information, use flags.HasFlag(...) to test for those Message Message entities for styled text Inline keyboard Disable webpage preview Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Geolocation See Extra bits of information, use flags.HasFlag(...) to test for those Geolocation For live locations, a direction in which the location moves, in degrees; 1-360 Validity period For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000) Reply markup for bot/inline keyboards Field has a value Field has a value Field has a value Field has a value Venue See Extra bits of information, use flags.HasFlag(...) to test for those Geolocation Venue name Address Venue provider: currently only "foursquare" and "gplaces" (Google Places) need to be supported Venue ID in the provider's database Venue type in the provider's database Inline keyboard Field has a value A contact See Extra bits of information, use flags.HasFlag(...) to test for those Phone number First name Last name VCard info Inline keyboard Field has a value A game See Extra bits of information, use flags.HasFlag(...) to test for those Inline keyboard Field has a value An invoice See Extra bits of information, use flags.HasFlag(...) to test for those Product name, 1-32 characters Product description, 1-255 characters Invoice photo The invoice Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. Payments provider token, obtained via Botfather A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. Inline keyboard Field has a value Field has a value Specifies options that will be used to generate the link preview for the message, or even a standalone link preview without an attached message. See Extra bits of information, use flags.HasFlag(...) to test for those The message, can be empty. Message entities for styled text The URL to use for the link preview. Inline keyboard Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. If set, specifies that a large media preview should be used. If set, specifies that a small media preview should be used. If not set, a WEBPAGE_NOT_FOUND RPC error will be emitted if a webpage preview cannot be generated for the specified url; otherwise, no error will be emitted (unless the provided message is also empty, in which case a MESSAGE_EMPTY will be emitted, instead). Inline bot result See Derived classes: , , , ID of result Message to send when the result is selected An inline bot result See Extra bits of information, use flags.HasFlag(...) to test for those ID of result Result type (see bot API docs) Result title Result description URL of result Thumbnail for result Result contents Message to send when the result is selected Field has a value Field has a value Field has a value Field has a value Field has a value ID of result Message to send when the result is selected Photo See Result ID Result type (see bot API docs) Photo to send Message to send when the result is selected Result ID Message to send when the result is selected Document (media of any type except for photos) See Extra bits of information, use flags.HasFlag(...) to test for those Result ID Result type (see bot API docs) Result title Result description Document to send Message to send when the result is selected Field has a value Field has a value Result ID Message to send when the result is selected Game See Result ID Game short name Message to send when the result is selected Result ID Message to send when the result is selected Inline message See Derived classes: , , , , , , Send whatever media is attached to the See Extra bits of information, use flags.HasFlag(...) to test for those Caption Message entities for styled text Inline keyboard Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Send a simple text message See Extra bits of information, use flags.HasFlag(...) to test for those The message Message entities for styled text Inline keyboard Disable webpage preview Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Send a geolocation See Extra bits of information, use flags.HasFlag(...) to test for those Geolocation For live locations, a direction in which the location moves, in degrees; 1-360. Validity period For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). Inline keyboard Field has a value Field has a value Field has a value Field has a value Send a venue See Extra bits of information, use flags.HasFlag(...) to test for those Geolocation of venue Venue name Address Venue provider: currently only "foursquare" and "gplaces" (Google Places) need to be supported Venue ID in the provider's database Venue type in the provider's database Inline keyboard Field has a value Send a contact See Extra bits of information, use flags.HasFlag(...) to test for those Phone number First name Last name VCard info Inline keyboard Field has a value Send an invoice See Extra bits of information, use flags.HasFlag(...) to test for those Product name, 1-32 characters Product description, 1-255 characters Product photo Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Inline keyboard Field has a value Set this flag if you require the user's shipping address to complete the order Field has a value Test invoice Specifies options that must be used to generate the link preview for the message, or even a standalone link preview without an attached message. See Extra bits of information, use flags.HasFlag(...) to test for those The message, can be empty. Message entities for styled text The URL to use for the link preview. Reply markup for sending bot buttons Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. If set, specifies that a large media preview should be used. If set, specifies that a small media preview should be used. If set, indicates that the URL used for the webpage preview was specified manually using , and may not be related to any of the URLs specified in the message. If set, the link can be opened directly without user confirmation. Results of an inline query See Derived classes: , Result ID Result type (see bot API docs) Result title Result description Message to send Generic result See Extra bits of information, use flags.HasFlag(...) to test for those Result ID Result type (see bot API docs) Result title Result description URL of article or webpage Thumbnail for the result Content of the result Message to send Field has a value Field has a value Field has a value Field has a value Field has a value Result ID Result type (see bot API docs) Result title Result description Message to send Media result See Extra bits of information, use flags.HasFlag(...) to test for those Result ID Result type (see bot API docs) If type is photo, the photo to send If type is document, the document to send Result title Description Depending on the type and on the , contains the caption of the media or the content of the message to be sent instead of the media Field has a value Field has a value Field has a value Field has a value Result ID Result type (see bot API docs) Result title Description Depending on the type and on the , contains the caption of the media or the content of the message to be sent instead of the media Result of a query to an inline bot See Extra bits of information, use flags.HasFlag(...) to test for those Query ID The next offset to use when navigating through results Shown as a button on top of the remaining inline result list; if clicked, redirects the user to a private chat with the bot with the specified start parameter. Shown as a button on top of the remaining inline result list; if clicked, opens the specified inline mode mini app. The results Caching validity of the results Users mentioned in the results Whether the result is a picture gallery Field has a value Field has a value Field has a value Link to a message in a supergroup/channel See URL Embed code Info about a forwarded message See Extra bits of information, use flags.HasFlag(...) to test for those The ID of the user that originally sent the message The name of the user that originally sent the message When was the message originally sent ID of the channel message that was forwarded For channels and if signatures are enabled, author of the channel message Only for messages forwarded to saved messages », contains the dialog where the message was originally sent. Only for messages forwarded to saved messages », contains the original ID of the message in saved_from_peer. Only for forwarded messages reforwarded to saved messages », contains the sender of the original message (i.e. if user A sends a message, then user B forwards it somewhere, then user C saves it to saved messages, this field will contain the ID of user B and from_id will contain the ID of user A). Only for forwarded messages from users with forward privacy enabled, sent by users with forward privacy enabled, reforwarded to saved messages », contains the sender of the original message (i.e. if user A (fwd privacy enabled) sends a message, then user B (fwd privacy enabled) forwards it somewhere, then user C saves it to saved messages, this field will contain the name of user B and from_name will contain the name of user A). Only for forwarded messages reforwarded to saved messages », indicates when was the original message sent (i.e. if user A sends a message @ unixtime 1, then user B forwards it somewhere @ unixtime 2, then user C saves it to saved messages @ unixtime 3, this field will contain 2, date will contain 1 and the date of the containing will contain 3). PSA type Field has a value Field has a value Field has a value Fields and have a value Field has a value Field has a value Whether this message was imported from a foreign chat service, click here for more info » Field has a value Field has a value Field has a value Only for messages forwarded to saved messages », set if the original message was outgoing (though the message may have been originally outgoing even if this flag is not set, if from_id points to the current user). Type of verification code that will be sent next if you call the resendCode method See The next time, the authentication code will be delivered via an immediately canceled incoming call. The next time, the authentication code is to be delivered via an outgoing phone call. The next time, the authentication code will be delivered via an immediately canceled incoming call. The next time, the authentication code will be delivered via an immediately canceled incoming call, handled manually by the user. The next time, the authentication code will be delivered via fragment.com Type of the verification code that was sent See Derived classes: , , , , , , , , , , The code was sent through the telegram app See Length of the code in bytes The code was sent via SMS See Length of the code in bytes The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input. See Length of the verification code The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern. See pattern to match The code will be sent via a flash phone call, that will be closed immediately. The last digits of the phone number that calls are the code that must be entered manually by the user. See Prefix of the phone number from which the call will be made The code was sent via the previously configured login email » See Extra bits of information, use flags.HasFlag(...) to test for those Pattern of the email Length of the sent verification code Clients should wait for the specified amount of seconds before allowing the user to invoke Auth_ResetLoginEmail (will be 0 for Premium users). An email reset was already requested, and will occur at the specified date. Whether authorization through Apple ID is allowed Whether authorization through Google ID is allowed Field has a value Field has a value The user should add and verify an email address in order to login as described here ». See Extra bits of information, use flags.HasFlag(...) to test for those Whether authorization through Apple ID is allowed Whether authorization through Google ID is allowed The code was delivered via fragment.com. See Open the specified URL to log into fragment.com with the wallet that owns the specified phone number and view the code. An authentication code should be delivered via SMS after Firebase attestation, as described in the auth documentation ». See Extra bits of information, use flags.HasFlag(...) to test for those On Android, the nonce to be used as described in the auth documentation » Google Play Integrity project ID Play Integrity API nonce On iOS, must be compared with the receipt extracted from the received push notification. On iOS: if a push notification with the ios_push_secret isn't received within push_timeout seconds, the next_type authentication method must be used, with Auth_ResendCode. Field has a value Fields and have a value Fields and have a value The code was sent via SMS as a secret word, starting with the letter specified in beginning See Extra bits of information, use flags.HasFlag(...) to test for those If set, the secret word in the sent SMS (which may contain multiple words) starts with this letter. Field has a value The code was sent via SMS as a secret phrase starting with the word specified in beginning See Extra bits of information, use flags.HasFlag(...) to test for those If set, the secret phrase (and the SMS) starts with this word. Field has a value Callback answer sent by the bot in response to a button press See Extra bits of information, use flags.HasFlag(...) to test for those Alert to show URL to open For how long should this answer be cached Field has a value Whether an alert should be shown to the user instead of a toast notification Field has a value Whether an URL is present Whether to show games in WebView or in native UI. Message edit data for media See Extra bits of information, use flags.HasFlag(...) to test for those Media caption, if the specified media's caption can be edited Represents a sent inline message from the perspective of a bot See Derived classes: , DC ID to use when working with this inline message Access hash of message Represents a sent inline message from the perspective of a bot (legacy constructor) See DC ID to use when working with this inline message ID of message, contains both the (32-bit, legacy) owner ID and the message ID, used only for Bot API backwards compatibility with 32-bit user ID. ⚠ REQUIRED FIELD. See how to obtain it
Access hash of message DC ID to use when working with this inline message Access hash of message Represents a sent inline message from the perspective of a bot See DC ID to use when working with this inline message ID of the owner of this message ID of message ⚠ REQUIRED FIELD. See how to obtain it
Access hash of message DC ID to use when working with this inline message Access hash of message The bot requested the user to message them in private See Text for the button that switches the user to a private chat with the bot and sends the bot a start message with the parameter start_parameter (can be empty) The parameter for the /start parameter Dialog info of multiple peers See Dialog info Messages mentioned in dialog info Chats Users Current update state of dialog returns a or for the given Peer Top peer See Peer Rating as computed in top peer rating » Top peer category See Most used bots Most used inline bots Users we've chatted most frequently with Often-opened groups and supergroups Most frequently visited channels Most frequently called users Users to which the users often forwards messages to Chats to which the users often forwards messages to Most frequently used Main Mini Bot Apps. Top peer category See Top peer category of peers Count of peers Peers Top peers See Derived classes: , a value means contacts.topPeersNotModified Top peers See Top peers by top peer category Chats Users returns a or for the given Peer Top peers disabled See Represents a message draft. See Derived classes: , Empty draft See Extra bits of information, use flags.HasFlag(...) to test for those When was the draft last updated Field has a value Represents a message draft. See Extra bits of information, use flags.HasFlag(...) to test for those If set, indicates that the message should be sent in reply to the specified message or story. The draft Message entities for styled text. Media. Date of last update of the draft. A message effect that should be played as specified here ». Whether no webpage preview will be generated Field has a value Field has a value Field has a value If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Field has a value Featured stickers See Derived classes: , Featured stickers haven't changed See Total number of featured stickers Featured stickersets See Extra bits of information, use flags.HasFlag(...) to test for those Hash used for caching, for more info click here Total number of featured stickers Featured stickersets IDs of new featured stickersets Whether this is a premium stickerset Recently used stickers See a value means messages.recentStickersNotModified Hash used for caching, for more info click here Emojis associated to stickers Recent stickers When was each sticker last used Archived stickersets See Number of archived stickers Archived stickersets Result of stickerset installation process See Derived classes: , The stickerset was installed successfully See The stickerset was installed, but since there are too many stickersets some were archived See Archived stickersets Stickerset preview See Derived classes: , , , Stickerset Stickerset with a single sticker as preview See Stickerset Preview Stickerset Stickerset, with multiple stickers as preview See Stickerset Preview stickers Stickerset Stickerset preview with all stickers of the stickerset included.
Currently used only for custom emoji stickersets, to avoid a further call to Messages_GetStickerSet. See Stickerset Emoji information about every sticker in the stickerset Keywords for some or every sticker in the stickerset. Stickers Stickerset Just the stickerset information, with no previews. See Stickerset information. Stickerset information. Position on a photo where a mask should be placed when attaching stickers to media » See Part of the face, relative to which the mask should be placed Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position) Shift by Y-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just below the default mask position) Mask scaling coefficient. (For example, 2.0 means a doubled size) Represents a media with attached stickers See Derived classes: , A photo with stickers attached See The photo A document with stickers attached See The document Indicates an already sent game See Extra bits of information, use flags.HasFlag(...) to test for those ID of the game Access hash of the game Short name for the game Title of the game Game description Game preview Optional attached document Field has a value A game to send See Derived classes: , Indicates an already sent game See game ID from constructor ⚠ REQUIRED FIELD. See how to obtain it
access hash from constructor Game by short name See The bot that provides the game The game's short name, usually obtained from a game link » Game highscore See Position in highscore list User ID Score Highscores in a game See Highscores Users, associated to the highscores Rich text See Derived classes: , , , , , , , , , , , , , , a value means textEmpty Plain text See Text Bold text See Text Italic text See Text Underlined text See Text Strikethrough text See Text fixed-width rich text See Text Link See Text of link Webpage HTTP URL If a preview was already generated for the page, the page ID Rich text email link See Link text Email address Concatenation of rich texts See Concatenated rich texts Subscript text See Text Superscript text See Text Highlighted text See Text Rich text linked to a phone number See Text Phone number Inline image See Document ID Width Height Text linking to another section of the page See Text Section name Represents an instant view page element See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , Unsupported IV element See Title See Title Subtitle See Text Author and date of creation of article See Author name Date of publication Page header See Contents Subheader See Subheader A paragraph See Text Preformatted (<pre> text) See Text Programming language of preformatted text Page footer See Contents An empty block separating a page See Link to section within the page itself (like <a href="#target">anchor</a>) See Name of target section Unordered list of IV blocks See List of blocks in an IV page Quote (equivalent to the HTML <blockquote>) See Quote contents Caption Pullquote See Text Caption A photo See Extra bits of information, use flags.HasFlag(...) to test for those Photo ID Caption HTTP URL of page the photo leads to when clicked ID of preview of the page the photo leads to when clicked Fields and have a value Video See Extra bits of information, use flags.HasFlag(...) to test for those Video ID Caption Whether the video is set to autoplay Whether the video is set to loop A page cover See Cover An embedded webpage See Extra bits of information, use flags.HasFlag(...) to test for those Web page URL, if available HTML-markup of the embedded page Poster photo, if available Block width, if known Block height, if known Caption Whether the block should be full width Field has a value Field has a value Whether scrolling should be allowed Field has a value Fields and have a value An embedded post See Web page URL ID of generated webpage preview ID of the author's photo Author name Creation date Post contents Caption Collage of media See Media elements Caption Slideshow See Slideshow items Caption Reference to a telegram channel See The channel/supergroup/chat Audio See Audio ID (to be fetched from the container Audio caption Kicker See Contents Table See Extra bits of information, use flags.HasFlag(...) to test for those Title Table rows Does the table have a visible border? Is the table striped? Ordered list of IV blocks See List items A collapsible details block See Extra bits of information, use flags.HasFlag(...) to test for those Block contents Always visible heading for the block Whether the block is open by default Related articles See Title Related articles A map See Location of the map center Map zoom level; 13-20 Map width in pixels before applying scale; 16-102 Map height in pixels before applying scale; 16-1024 Caption Why was the phone call discarded? See The phone call was missed The phone call was disconnected The phone call was ended normally The phone call was discarded because the user is busy in another call Represents a json-encoded object See JSON-encoded object This object represents a portion of the price for goods or services. See Portion label Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Invoice See Extra bits of information, use flags.HasFlag(...) to test for those Three-letter ISO 4217 currency code, or XTR for Telegram Stars. Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). A vector of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. Terms of service URL Test invoice Set this flag if you require the user's full name to complete the order Set this flag if you require the user's phone number to complete the order Set this flag if you require the user's email address to complete the order Set this flag if you require the user's shipping address to complete the order Set this flag if the final price depends on the shipping method Set this flag if user's phone number should be sent to provider Set this flag if user's email address should be sent to provider Fields and have a value Whether this is a recurring payment Field has a value Field has a value Payment identifier See Telegram payment identifier Provider payment identifier Shipping address See First line for the address Second line for the address City State, if applicable (empty otherwise) ISO 3166-1 alpha-2 country code Address post code Order info provided by the user See Extra bits of information, use flags.HasFlag(...) to test for those User's full name User's phone number User's email address User's shipping address Field has a value Field has a value Field has a value Field has a value Saved payment credentials See Derived classes: Saved credit card See Card ID Title Remote document See Derived classes: , Document URL File size MIME type Attributes for media types Remote document See Document URL Access hash File size MIME type Attributes for media types Document URL File size MIME type Attributes for media types Remote document that can be downloaded without proxying through telegram See Document URL File size MIME type Attributes for media types Document URL File size MIME type Attributes for media types The document See Remote document URL to be downloaded using the appropriate method Remote file size Mime type Attributes for media types Location of remote file See Derived classes: , , Location of a remote HTTP(s) file See HTTP URL of file ⚠ REQUIRED FIELD. See how to obtain it
Access hash Used to download a server-generated image with the map preview from a , see the webfile docs for more info ». See Generated from the lat, long and accuracy_radius parameters of the ⚠ REQUIRED FIELD. See how to obtain it
Access hash of the Map width in pixels before applying scale; 16-1024 Map height in pixels before applying scale; 16-1024 Map zoom level; 13-20 Map scale; 1-3 Used to download an album cover for any music file using Upload_GetWebFile, see the webfile docs for more info ». See Extra bits of information, use flags.HasFlag(...) to test for those The audio file in question: must NOT be provided in secret chats, provide the title and performer fields instead. Song title: should only be used in secret chats, in normal chats provide document instead, as it has more lax rate limits. Song performer: should only be used in secret chats, in normal chats provide document instead, as it has more lax rate limits. Field has a value Fields and have a value Used to return a thumbnail with 100x100 resolution (instead of the default 600x600) Represents a chunk of an HTTP webfile downloaded through telegram's secure MTProto servers See File size Mime type File type Modified time Data Payment form See Derived classes: , , Form ID Invoice Payment form See Extra bits of information, use flags.HasFlag(...) to test for those Form ID Bot ID Form title Description Product photo Invoice Payment provider ID. Payment form URL Payment provider name.
One of the following:
- stripe Contains information about the payment provider, if available, to support it natively without the need for opening the URL.
A JSON object that can contain the following fields:

- apple_pay_merchant_id: Apple Pay merchant ID
- google_pay_public_key: Google Pay public key
- need_country: True, if the user country must be provided,
- need_zip: True, if the user ZIP/postal code must be provided,
- need_cardholder_name: True, if the cardholder name must be provided
 Additional payment methods Saved server-side order information Contains information about saved card credentials Users Field has a value Field has a value Whether the user can choose to save credentials. Indicates that the user can save payment credentials, but only after setting up a 2FA password (currently the account doesn't have a 2FA password) Fields and have a value Field has a value Field has a value Form ID Invoice Represents a payment form, for payments to be using Telegram Stars, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Form ID. Bot ID. Form title Description Product photo Invoice Info about users mentioned in the other fields. Field has a value Form ID. Invoice Represents a payment form for a gift, see here » for more info. See Form ID. Invoice Form ID. Invoice Validated user-provided info See Extra bits of information, use flags.HasFlag(...) to test for those ID Shipping options Field has a value Field has a value Payment result See Derived classes: , Payment result See Info about the payment Payment was not successful, additional verification is needed See URL for additional payment credentials verification Payment receipt See Derived classes: , Date of generation Bot ID Title Description Photo Invoice Three-letter ISO 4217 currency code Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Users Receipt See Extra bits of information, use flags.HasFlag(...) to test for those Date of generation Bot ID Provider ID Title Description Photo Invoice Info Selected shipping option Tipped amount Three-letter ISO 4217 currency code Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Payment credential name Users Field has a value Field has a value Field has a value Field has a value Date of generation Bot ID Title Description Photo Invoice Three-letter ISO 4217 currency code Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Users Receipt for payment made using Telegram Stars. See Extra bits of information, use flags.HasFlag(...) to test for those Date of generation Bot ID Title Description Product photo Invoice Currency, always XTR. Amount of Telegram Stars. Transaction ID Info about users mentioned in the other fields. Field has a value Date of generation Bot ID Title Description Product photo Invoice Currency, always XTR. Amount of Telegram Stars. Info about users mentioned in the other fields. Saved server-side order information See Extra bits of information, use flags.HasFlag(...) to test for those Saved server-side order information Field has a value Whether the user has some saved payment credentials Payment credentials See Derived classes: , , , Saved payment credentials See Credential ID Temporary password Payment credentials See Extra bits of information, use flags.HasFlag(...) to test for those Payment credentials Save payment credential for future use Apple pay payment credentials See Payment data Google Pay payment credentials See Payment token Temporary payment password See Temporary password Validity period Shipping option See Option ID Title List of price portions Sticker in a stickerset See Extra bits of information, use flags.HasFlag(...) to test for those The sticker Associated emoji Coordinates for mask sticker Set of keywords, separated by commas (can't be provided for mask stickers) Field has a value Field has a value Phone call See Call ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash Phone call See Derived classes: , , , , , Call ID Access hash Date Admin ID Participant ID Phone call protocol info Empty constructor See Call ID Call ID Incoming phone call See Extra bits of information, use flags.HasFlag(...) to test for those Call ID Access hash Date Admin ID Participant ID Phone call protocol info When was the phone call received Field has a value Is this a video call Call ID Access hash Date Admin ID Participant ID Phone call protocol info Requested phone call See Extra bits of information, use flags.HasFlag(...) to test for those Phone call ID Access hash When was the phone call created ID of the creator of the phone call ID of the other participant of the phone call Parameter for key exchange Call protocol info to be passed to libtgvoip Whether this is a video call Phone call ID Access hash When was the phone call created ID of the creator of the phone call ID of the other participant of the phone call Call protocol info to be passed to libtgvoip An accepted phone call See Extra bits of information, use flags.HasFlag(...) to test for those ID of accepted phone call Access hash of phone call When was the call accepted ID of the call creator ID of the other user in the call B parameter for secure E2E phone call key exchange Protocol to use for phone call Whether this is a video call ID of accepted phone call Access hash of phone call When was the call accepted ID of the call creator ID of the other user in the call Protocol to use for phone call Phone call See Extra bits of information, use flags.HasFlag(...) to test for those Call ID Access hash Date of creation of the call User ID of the creator of the call User ID of the other participant in the call Parameter for key exchange Key fingerprint Call protocol info to be passed to libtgvoip List of endpoints the user can connect to exchange call data When was the call actually started Custom JSON-encoded call parameters to be passed to tgcalls. Whether P2P connection to the other peer is allowed Whether this is a video call Field has a value Call ID Access hash Date of creation of the call User ID of the creator of the call User ID of the other participant in the call Call protocol info to be passed to libtgvoip Indicates a discarded phone call See Extra bits of information, use flags.HasFlag(...) to test for those Call ID Why was the phone call discarded Duration of the phone call in seconds Field has a value Field has a value Whether the server required the user to Phone_SetCallRating the call Whether the server required the client to Phone_SaveCallDebug the libtgvoip call debug data Whether the call was a video call Call ID Phone call connection See Derived classes: , Endpoint ID IP address of endpoint IPv6 address of endpoint Port ID Identifies an endpoint that can be used to connect to the other user in a phone call See Extra bits of information, use flags.HasFlag(...) to test for those Endpoint ID IP address of endpoint IPv6 address of endpoint Port ID Our peer tag Whether TCP should be used Endpoint ID IP address of endpoint IPv6 address of endpoint Port ID WebRTC connection parameters See Extra bits of information, use flags.HasFlag(...) to test for those Endpoint ID IP address IPv6 address Port Username Password Whether this is a TURN endpoint Whether this is a STUN endpoint Endpoint ID IP address IPv6 address Port Protocol info for libtgvoip See Extra bits of information, use flags.HasFlag(...) to test for those Minimum layer for remote libtgvoip Maximum layer for remote libtgvoip When using Phone_RequestCall and Phone_AcceptCall, specify all library versions supported by the client.
The server will merge and choose the best library version supported by both peers, returning only the best value in the result of the callee's Phone_AcceptCall and in the update received by the caller. Whether to allow P2P connection to the other participant Whether to allow connection to the other participants through the reflector servers A VoIP phone call See The VoIP phone call VoIP phone call participants Represents the download status of a CDN file See Derived classes: , The file was cleared from the temporary RAM cache of the CDN and has to be re-uploaded. See Request token (see CDN) Represent a chunk of a CDN file. See The data Public key to use only during handshakes to CDN DCs. See CDN DC ID RSA public key Configuration for CDN file downloads. See Vector of public keys to use only during handshakes to CDN DCs. Language pack string See Derived classes: , , Language key Translated localization string See Language key Value Language key A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info See Extra bits of information, use flags.HasFlag(...) to test for those Localization key Value for zero objects Value for one object Value for two objects Value for a few objects Value for many objects Default value Field has a value Field has a value Field has a value Field has a value Field has a value Localization key Deleted localization string See Localization key Localization key Changes to the app's localization pack See Language code Previous version number New version number Localized strings Identifies a localization pack See Extra bits of information, use flags.HasFlag(...) to test for those Language name Language name in the language itself Language code (pack identifier) Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it should be fetched from base language pack. Unsupported in custom language packs A language code to be used to apply plural forms. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info Total number of non-deleted strings from the language pack Total number of translated strings from the language pack Link to language translation interface; empty for custom local language packs Whether the language pack is official Field has a value Is this a localization pack for an RTL language Is this a beta localization pack? Channel admin log event See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , Channel/supergroup title was changed See Previous title New title The description was changed See Previous description New description Channel/supergroup username was changed See Old username New username The channel/supergroup's picture was changed See Previous picture New picture Invites were enabled/disabled See New value Channel signatures were enabled/disabled See New value A message was pinned See The message that was pinned A message was edited See Old message New message A message was deleted See The message that was deleted A user has joined the group (in the case of big groups, info of the user that has joined isn't shown) See A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown) See A user was invited to the group See The user that was invited The banned rights of a user were changed See Old banned rights of user New banned rights of user The admin rights of a user were changed See Previous admin rights New admin rights The supergroup's stickerset was changed See Previous stickerset New stickerset The hidden prehistory setting was Channels_TogglePreHistoryHidden See New value The default banned rights were modified See Previous global banned rights New global banned rights. A poll was stopped See The poll that was stopped The linked chat was changed See Previous linked chat New linked chat The geogroup location was changed See Previous location New location Channels_ToggleSlowMode See Previous slow mode value New slow mode value A group call was started See Group call A group call was terminated See The group call that was terminated A group call participant was muted See The participant that was muted A group call participant was unmuted See The participant that was unmuted Group call settings were changed See Whether all users are muted by default upon joining A user joined the supergroup/channel using a specific invite link See Extra bits of information, use flags.HasFlag(...) to test for those The invite link used to join the supergroup/channel The participant joined by importing a chat folder deep link ». A chat invite was deleted See The deleted chat invite A specific invite link was revoked See The invite link that was revoked A chat invite was edited See Previous chat invite information New chat invite information channelAdminLogEvent.user_id has set the volume of participant.peer to participant.volume See The participant whose volume was changed The Time-To-Live of messages in this chat was changed See Previous value New value A new member was accepted to the chat by an admin See The invite link that was used to join the chat ID of the admin that approved the invite Forwards were enabled or disabled See Old value A message was posted in a channel See The message that was sent The set of allowed message reactions » for this channel has changed See Previously allowed reaction emojis New allowed reaction emojis The list of usernames associated with the channel was changed See Previous set of usernames New set of usernames Forum functionality was enabled or disabled. See Whether forum functionality was enabled or disabled. A forum topic was created See The forum topic that was created A forum topic was edited See Previous topic information New topic information A forum topic was deleted See The forum topic that was deleted A forum topic was pinned or unpinned See Extra bits of information, use flags.HasFlag(...) to test for those Previous topic information New topic information Field has a value Field has a value Native antispam functionality was enabled or disabled. See Whether antispam functionality was enabled or disabled. The message accent color was changed See Previous accent palette New accent palette The profile accent color was changed See The wallpaper was changed See Previous wallpaper New wallpaper The emoji status was changed See Previous emoji status New emoji status The supergroup's custom emoji stickerset was changed. See Channel signature profiles were enabled/disabled. See A paid subscriber has extended their Telegram Star subscription ». See Admin log event See Event ID Date User ID Action Admin log events See Admin log events Chats mentioned in events Users mentioned in events returns a or for the given Peer Filter only certain admin log events See Extra bits of information, use flags.HasFlag(...) to test for those Join events, including joins using invite links and join requests. Leave events Invite events Ban events Unban events Kick events Unkick events Admin promotion events Admin demotion events Info change events (when about, linked chat, location, photo, stickerset, title or username, slowmode, history TTL settings of a channel gets modified) Settings change events (invites, hidden prehistory, signatures, default banned rights, forum toggle events) Message pin events Message edit events Message deletion events Group call events Invite events A message was posted in a channel Forum-related events Telegram Star subscription extension events » Popular contact See Contact identifier How many people imported this contact Favorited stickers See a value means messages.favedStickersNotModified Hash used for caching, for more info click here Emojis associated to stickers Favorited stickers Recent t.me urls See Derived classes: , , , , URL Unknown t.me url See Recent t.me link to a user See User ID Recent t.me link to a chat See Chat ID Recent t.me invite link to a chat See Chat invitation Recent t.me stickerset installation URL See Stickerset Recent t.me URLs See URLs Chats Users returns a or for the given Peer A single media in an album or grouped media sent with Messages_SendMultiMedia. See Extra bits of information, use flags.HasFlag(...) to test for those The media Unique client media ID required to prevent message resending A caption for the media Message entities for styled text Field has a value Represents a bot logged in using the Telegram login widget See Authorization hash Bot ID The domain name of the website on which the user has logged in. Browser user-agent Platform When was the web session created When was the web session last active IP address Region, determined from IP address Web authorizations See Web authorization list Users A message See Derived classes: , , , Message by ID See Message ID Message to which the specified message replies to See ID of the message that replies to the message we need Pinned message See Used by bots for fetching information about the message that originated a callback query See Message ID Callback query ID Peer, or all peers in a certain folder See Derived classes: , A peer See Peer All peers in a peer folder See Peer folder ID, for more info click here Peer, or all peers in a folder See Derived classes: , Peer See Peer Peer folder See Peer folder ID, for more info click here Found stickersets See a value means messages.foundStickerSetsNotModified Hash used for caching, for more info click here Found stickersets SHA256 Hash of an uploaded file, to be checked for validity after download See Offset from where to start computing SHA-256 hash Length SHA-256 Hash of file chunk, to be checked for validity after download Info about an MTProxy used to connect. See Proxy address Proxy port Update of Telegram's terms of service See Derived classes: , No changes were made to telegram's terms of service See New TOS updates will have to be queried using Help_GetTermsOfServiceUpdate in expires seconds Info about an update of telegram's terms of service. If the terms of service are declined, then the Account_DeleteAccount method should be called with the reason "Decline ToS update" See New TOS updates will have to be queried using Help_GetTermsOfServiceUpdate in expires seconds New terms of service Secure passport file, for more info see the passport docs » See Derived classes: , Secure file ID Uploaded secure file, for more info see the passport docs » See Secure file ID Secure file part count MD5 hash of encrypted uploaded file, to be checked server-side File hash Secret Secure file ID Pre-uploaded passport file, for more info see the passport docs » See Secure file ID ⚠ REQUIRED FIELD. See how to obtain it
Secure file access hash Secure file ID Secure passport file, for more info see the passport docs » See a value means secureFileEmpty ID Access hash File size DC ID Date of upload File hash Secret Secure passport data, for more info see the passport docs » See Data Data hash Secret Plaintext verified passport data. See Derived classes: , Phone number to use in telegram passport: it must be verified, first ». See Phone number Email address to use in telegram passport: it must be verified, first ». See Email address Secure value type See Personal details Passport Driver's license Identity card Internal passport Address Utility bill Bank statement Rental agreement Internal registration passport Temporary registration Phone Email Secure value See Extra bits of information, use flags.HasFlag(...) to test for those Secure passport value type Encrypted Telegram Passport element data Encrypted passport file with the front side of the document Encrypted passport file with the reverse side of the document Encrypted passport file with a selfie of the user holding the document Array of encrypted passport files with translated versions of the provided documents Array of encrypted passport files with photos the of the documents Plaintext verified passport data Data hash Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Secure value, for more info see the passport docs » See Extra bits of information, use flags.HasFlag(...) to test for those Secure passport value type Encrypted Telegram Passport element data Encrypted passport file with the front side of the document Encrypted passport file with the reverse side of the document Encrypted passport file with a selfie of the user holding the document Array of encrypted passport files with translated versions of the provided documents Array of encrypted passport files with photos the of the documents Plaintext verified passport data Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Field has a value Secure value hash See Secure value type Hash Secure value error See Derived classes: , , , , , , , , The section of the user's Telegram Passport which has the error, one of , , , , , Error message Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. See The section of the user's Telegram Passport which has the error, one of , , , , , Data hash Name of the data field which has the error Error message The section of the user's Telegram Passport which has the error, one of , , , , , Error message Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. See One of , , , File hash Error message One of , , , Error message Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. See One of , File hash Error message One of , Error message Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. See One of , , , File hash Error message One of , , , Error message Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. See One of , , , , File hash Error message One of , , , , Error message Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. See One of , , , , File hash Error message One of , , , , Error message Secure value error See Type of element which has the issue Hash Error message Type of element which has the issue Error message Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. See Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. See Encrypted credentials required to decrypt telegram passport data. See Encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication, as described in decrypting data » Data hash for data authentication as described in decrypting data » Secret, encrypted with the bot's public RSA key, required for data decryption as described in decrypting data » Telegram Passport authorization form See Extra bits of information, use flags.HasFlag(...) to test for those Required Telegram Passport documents Already submitted Telegram Passport documents Telegram Passport errors Info about the bot to which the form will be submitted URL of the service's privacy policy Field has a value The sent email code See The email (to which the code was sent) must match this pattern The length of the verification code Deep link info, see the here for more details See a value means help.deepLinkInfoEmpty Extra bits of information, use flags.HasFlag(...) to test for those Message to show to the user Message entities for styled text An update of the app is required to parse this link Field has a value Saved contact See Derived classes: Saved contact See Phone number First name Last name Date added Takeout info See Takeout ID Key derivation function to use when generating the password hash for SRP two-factor authorization See Derived classes: a value means passwordKdfAlgoUnknown This key derivation algorithm defines that SRP 2FA login must be used See One of two salts used by the derivation function (see SRP 2FA login) One of two salts used by the derivation function (see SRP 2FA login) Base (see SRP 2FA login) 2048-bit modulus (see SRP 2FA login) KDF algorithm to use for computing telegram passport hash See Derived classes: , a value means securePasswordKdfAlgoUnknown Salt PBKDF2 with SHA512 and 100000 iterations KDF algo See SHA512 KDF algo See Secure settings See Secure KDF algo Secure secret Secret ID Constructor for checking the validity of a 2FA SRP password (see SRP) See a value means inputCheckPasswordEmpty SRP ID A parameter (see SRP) M1 parameter (see SRP) Required secure file type See Derived classes: , Required type See Extra bits of information, use flags.HasFlag(...) to test for those Secure value type Native names Is a selfie required Is a translation required One of See Secure required value types Telegram passport configuration See a value means help.passportConfigNotModified Hash used for caching, for more info click here Localization Event that occurred in the application. See Client's exact timestamp for the event Type of event Arbitrary numeric value for more convenient selection of certain event types, or events referring to a certain object Details of the event JSON key: value pair See Key Value JSON value See Derived classes: , , , , , null JSON value See JSON boolean value See Value JSON numeric value See Value JSON string See Value JSON array See JSON values JSON object value See Values Returns a JSON serialization string for this object Returns the given entry in native form (, , , Dictionary or ), or if the key is not found Converts the entries to a Dictionary with keys and values in native form (, , , Dictionary or ) Table cell See Extra bits of information, use flags.HasFlag(...) to test for those Content For how many columns should this cell extend For how many rows should this cell extend Is this element part of the column header Field has a value Field has a value Horizontally centered block Right-aligned block Vertically centered block Block vertically-aligned to the bottom Field has a value Table row See Table cells Page caption See Caption Credits Item in block list See Derived classes: , List item See Text List item See Blocks Represents an instant view ordered list See Derived classes: , Number of element within ordered list Ordered list of text items See Text Ordered list of IV blocks See Item contents Related article See Extra bits of information, use flags.HasFlag(...) to test for those URL of article Webpage ID of generated IV preview Title Description ID of preview photo Author name Date of publication Field has a value Field has a value Field has a value Field has a value Field has a value Instant view page See Extra bits of information, use flags.HasFlag(...) to test for those Original page HTTP URL Page elements (like with HTML elements, only as TL constructors) Photos in page Media in page View count Indicates that not full page preview is available to the client and it will need to fetch full Instant View from the server using Messages_GetWebPagePreview. Whether the page contains RTL text Whether this is an IV v2 page Field has a value Localized name for telegram support See Localized name Internal use See a value means help.userInfoEmpty Info Message entities for styled text Author Date A possible answer of a poll See Textual representation of the answer (only Premium users can use custom emoji entities here). The param that has to be passed to Messages_SendVote. Poll See ID of the poll Extra bits of information, use flags.HasFlag(...) to test for those The question of the poll (only Premium users can use custom emoji entities here). The possible answers, vote using Messages_SendVote. Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future; can't be used together with close_period. Whether the poll is closed and doesn't accept any more answers Whether cast votes are publicly visible to all users (non-anonymous poll) Whether multiple options can be chosen as answer Whether this is a quiz (with wrong and correct answers, results shown in the return type) Field has a value Field has a value A poll answer, and how users voted on it See Extra bits of information, use flags.HasFlag(...) to test for those The param that has to be passed to Messages_SendVote. How many users voted for this option Whether we have chosen this answer For quizzes, whether the option we have chosen is correct Results of poll See Extra bits of information, use flags.HasFlag(...) to test for those Poll results Total number of people that voted in the poll IDs of the last users that recently voted in the poll Explanation of quiz solution Message entities for styled text in quiz solution Similar to min objects, used for poll constructors that are the same for all users so they don't have the option chosen by the current user (you can use Messages_GetPollResults to get the full poll results). Field has a value Field has a value Field has a value Fields and have a value Number of online users in a chat See Number of online users URL with chat statistics See Chat statistics Represents the rights of an admin in a channel/supergroup. See Extra bits of information, use flags.HasFlag(...) to test for those If set, allows the admin to modify the description of the channel/supergroup If set, allows the admin to post messages in the channel If set, allows the admin to also edit messages from other admins in the channel If set, allows the admin to also delete messages from other admins in the channel If set, allows the admin to ban users from the channel/supergroup If set, allows the admin to invite users in the channel/supergroup If set, allows the admin to pin messages in the channel/supergroup If set, allows the admin to add other admins with the same (or more limited) permissions in the channel/supergroup Whether this admin is anonymous If set, allows the admin to change group call/livestream settings Set this flag if none of the other flags are set, but you still want the user to be an admin: if this or any of the other flags are set, the admin can get the chat admin log, get chat statistics, get message statistics in channels, get channel members, see anonymous administrators in supergroups and ignore slow mode. If set, allows the admin to create, delete or modify forum topics ». If set, allows the admin to post stories as the channel. If set, allows the admin to edit stories posted by the other admins of the channel. If set, allows the admin to delete stories posted by the other admins of the channel. Represents the rights of a normal user in a supergroup/channel/chat. In this case, the flags are inverted: if set, a flag does not allow a user to do X. See Extra bits of information, use flags.HasFlag(...) to test for those Validity of said permissions (it is considered forever any value less then 30 seconds or more then 366 days). If set, does not allow a user to view messages in a supergroup/channel/chat If set, does not allow a user to send messages in a supergroup/chat If set, does not allow a user to send any media in a supergroup/chat If set, does not allow a user to send stickers in a supergroup/chat If set, does not allow a user to send gifs in a supergroup/chat If set, does not allow a user to send games in a supergroup/chat If set, does not allow a user to use inline bots in a supergroup/chat. If set, does not allow a user to embed links in the messages of a supergroup/chat If set, does not allow a user to send polls in a supergroup/chat If set, does not allow any user to change the description of a supergroup/chat If set, does not allow any user to invite users in a supergroup/chat If set, does not allow any user to pin messages in a supergroup/chat If set, does not allow any user to create, delete or modify forum topics ». If set, does not allow a user to send photos in a supergroup/chat. If set, does not allow a user to send videos in a supergroup/chat. If set, does not allow a user to send round videos in a supergroup/chat. If set, does not allow a user to send audio files in a supergroup/chat. If set, does not allow a user to send voice messages in a supergroup/chat. If set, does not allow a user to send documents in a supergroup/chat. If set, does not allow a user to send text messages in a supergroup/chat. Wallpaper See Derived classes: , , Wallpaper See Wallpaper ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash Wallpaper by slug (a unique ID, obtained from a wallpaper link ») See Unique wallpaper ID Wallpaper with no file access hash, used for example when deleting (unsave=true) wallpapers using Account_SaveWallPaper, specifying just the wallpaper ID. See Wallpaper ID Installed wallpapers See a value means account.wallPapersNotModified Hash used for caching, for more info click here Wallpapers Settings used by telegram servers for sending the confirm code. See Extra bits of information, use flags.HasFlag(...) to test for those Previously stored future auth tokens, see the documentation for more info » Used only by official iOS apps for Firebase auth: device token for apple push. Used only by official iOS apps for firebase auth: whether a sandbox-certificate will be used during transmission of the push notification. Whether to allow phone verification via phone calls. Pass true if the phone number is used on the current device. Ignored if allow_flashcall is not set. If a token that will be included in eventually sent SMSs is required: required in newer versions of android, to use the android SMS receiver APIs Whether this device supports receiving the code using the method Field has a value Whether Firebase auth is supported Fields and have a value Set this flag if there is a SIM card in the current device, but it is not possible to check whether the specified phone number matches the SIM's phone number. Wallpaper rendering information. See Extra bits of information, use flags.HasFlag(...) to test for those Used for solid », gradient » and freeform gradient » fills. Used for gradient » and freeform gradient » fills. Used for freeform gradient » fills. Used for freeform gradient » fills. Used for pattern wallpapers ». Clockwise rotation angle of the gradient, in degrees; 0-359. Should be always divisible by 45. If set, this wallpaper can be used as a channel wallpaper and is represented by the specified UTF-8 emoji. Field has a value For image wallpapers »: if set, the JPEG must be downscaled to fit in 450x450 square and then box-blurred with radius 12. If set, the background needs to be slightly moved when the device is rotated. Field has a value Fields and have a value Field has a value Field has a value Field has a value Autodownload settings See Extra bits of information, use flags.HasFlag(...) to test for those Maximum size of photos to preload Maximum size of videos to preload Maximum size of other files to preload Maximum suggested bitrate for uploading videos A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files smaller than 20MB. A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files bigger than 20MB. Disable automatic media downloads? Whether to preload the first seconds of videos larger than the specified limit Whether to preload the next audio track when you're listening to music Whether to enable data saving mode in phone calls Whether to preload stories; in particular, the first .preload_prefix_size bytes of story videos should be preloaded. Media autodownload settings See Low data usage preset Medium data usage preset High data usage preset Emoji keyword See Keyword Emojis associated to keyword Deleted emoji keyword See Changes to emoji keywords See Language code for keywords Previous emoji keyword list version Current version of emoji keyword list Emojis associated to keywords An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation See An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation Emoji language See Language code Folder See Extra bits of information, use flags.HasFlag(...) to test for those Folder ID Folder title Folder picture Automatically add new channels to this folder Automatically add joined new public supergroups to this folder Automatically add new private chats to this folder Field has a value Peer in a folder See Peer Peer folder ID, for more info click here Peer in a folder See Folder peer info Peer folder ID, for more info click here Indicates how many results would be found by a Messages_Search call with the same parameters See Extra bits of information, use flags.HasFlag(...) to test for those Provided message filter Number of results that were found server-side If set, the results may be inexact URL authorization result See Derived classes: , a value means urlAuthResultDefault Details about the authorization request, for more info click here » See Extra bits of information, use flags.HasFlag(...) to test for those Username of a bot, which will be used for user authorization. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details. The domain name of the website on which the user will log in. Whether the bot would like to send messages to the user Details about an accepted authorization request, for more info click here » See The URL name of the website on which the user has logged in. Geographical location of supergroup (geogroups) See a value means channelLocationEmpty Geographical location of supergroup Textual description of the address Geolocated peer See Derived classes: , Validity period of current data Peer geolocated nearby See Peer Validity period of current data Distance from the peer in meters Validity period of current data Current peer See Expiry of geolocation info for current peer Expiry of geolocation info for current peer Restriction reason. See Platform identifier (ios, android, wp, all, etc.), can be concatenated with a dash as separator (android-ios, ios-wp, etc) Restriction reason (porno, terms, etc.) Error message to be shown to the user Cloud theme See Derived classes: , Theme See ID ⚠ REQUIRED FIELD. See how to obtain it
Access hash Theme by theme ID See Unique theme ID obtained from a theme deep link » Theme See Extra bits of information, use flags.HasFlag(...) to test for those Theme ID Theme access hash Unique theme ID Theme name Theme Theme settings Theme emoji Installation count Whether the current user is the creator of this theme Whether this is the default theme Field has a value Field has a value Field has a value Whether this theme is meant to be used as a chat theme Field has a value Installed themes See a value means account.themesNotModified Hash used for caching, for more info click here Themes Login token (for QR code login) See Derived classes: , , Login token (for QR code login) See Expiration date of QR code Token to render in QR code Repeat the query to the specified DC See DC ID Token to use for login Login via token (QR code) succeeded! See Authorization info Sensitive content settings See Extra bits of information, use flags.HasFlag(...) to test for those Whether viewing of sensitive (NSFW) content is enabled Whether the current client can change the sensitive content settings to view NSFW content Inactive chat list See When was the chat last active Chat list Users mentioned in the chat list returns a or for the given Peer Basic theme settings See Classic theme Day theme Night theme Tinted theme Arctic theme Theme settings See Extra bits of information, use flags.HasFlag(...) to test for those Default theme on which this theme is based Accent color, ARGB format Accent color of outgoing messages in ARGB format The fill to be used as a background for outgoing messages, in RGB24 format.
If just one or two equal colors are provided, describes a solid fill of a background.
If two different colors are provided, describes the top and bottom colors of a 0-degree gradient.
If three or four colors are provided, describes a freeform gradient fill of a background. or inputWallPaperSlug when passing wallpaper files for image or pattern wallpapers, with id=0 otherwise. Wallpaper settings. Field has a value Fields and have a value If set, the freeform gradient fill needs to be animated on every sent message Field has a value Theme settings See Extra bits of information, use flags.HasFlag(...) to test for those Base theme Accent color, ARGB format Accent color of outgoing messages in ARGB format The fill to be used as a background for outgoing messages, in RGB24 format.
If just one or two equal colors are provided, describes a solid fill of a background.
If two different colors are provided, describes the top and bottom colors of a 0-degree gradient.
If three or four colors are provided, describes a freeform gradient fill of a background. Wallpaper Field has a value Field has a value If set, the freeform gradient fill needs to be animated on every sent message. Field has a value Webpage attributes See Derived classes: , , Page theme See Extra bits of information, use flags.HasFlag(...) to test for those Theme files Theme settings Field has a value Field has a value Webpage preview of a Telegram story See Extra bits of information, use flags.HasFlag(...) to test for those Peer that posted the story Story ID May contain the story, if not the story should be fetched when and if needed using Stories_GetStoriesByID with the above id and peer. Field has a value Contains info about a stickerset », for a preview of a stickerset deep link » (the will have a type of telegram_stickerset). See Extra bits of information, use flags.HasFlag(...) to test for those A subset of the stickerset in the stickerset. Whether this i s a custom emoji stickerset. Whether the color of this TGS custom emoji stickerset should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context. How users voted in a poll See Extra bits of information, use flags.HasFlag(...) to test for those Total number of votes for all options (or only for the chosen option, if provided to Messages_GetPollVotes) Vote info for each user Mentioned chats Info about users that voted in the poll Offset to use with the next Messages_GetPollVotes request, empty string if no more results are available. Field has a value returns a or for the given Peer Credit card info URL provided by the bank See Info URL Bank name Credit card info, provided by the card's bank(s) See Credit card title Info URL(s) provided by the card's bank(s) Dialog filter (folder ») See Derived classes: , a value means dialogFilterDefault Folder ID Folder name (max 12 UTF-8 chars) Emoji to use as icon for the folder. A color ID for the folder tag associated to this folder, see here » for more info. Pinned chats, folders can have unlimited pinned chats Include the following chats in this folder Dialog filter AKA folder See Extra bits of information, use flags.HasFlag(...) to test for those Folder ID Folder name (max 12 UTF-8 chars) Emoji to use as icon for the folder. A color ID for the folder tag associated to this folder, see here » for more info. Pinned chats, folders can have unlimited pinned chats Include the following chats in this folder Exclude the following chats from this folder Whether to include all contacts in this folder Whether to include all non-contacts in this folder Whether to include all groups in this folder Whether to include all channels in this folder Whether to include all bots in this folder Whether to exclude muted chats from this folder Whether to exclude read chats from this folder Whether to exclude archived chats from this folder Field has a value Field has a value Folder ID Folder name (max 12 UTF-8 chars) Emoji to use as icon for the folder. A color ID for the folder tag associated to this folder, see here » for more info. Pinned chats, folders can have unlimited pinned chats Include the following chats in this folder A folder imported using a chat folder deep link ». See Extra bits of information, use flags.HasFlag(...) to test for those ID of the folder Name of the folder (max 12 UTF-8 chars) Emoji to use as icon for the folder. A color ID for the folder tag associated to this folder, see here » for more info. Pinned chats, folders can have unlimited pinned chats Chats to include in the folder Field has a value Whether the current user has created some chat folder deep links » to share the folder as well. Field has a value ID of the folder Name of the folder (max 12 UTF-8 chars) Emoji to use as icon for the folder. A color ID for the folder tag associated to this folder, see here » for more info. Pinned chats, folders can have unlimited pinned chats Chats to include in the folder Suggested folders See Folder info Folder description Channel statistics date range See Initial date Final date Statistics value couple; initial and final value for period of time currently in consideration See Current value Previous value Channel statistics percentage.
Compute the percentage simply by doing part * total / 100 See Partial value Total value Channel statistics graph See Derived classes: , , This channel statistics graph must be generated asynchronously using Stats_LoadAsyncGraph to reduce server load See Token to use for fetching the async graph An error occurred while generating the statistics graph See The error Channel statistics graph See Extra bits of information, use flags.HasFlag(...) to test for those Statistics data Zoom token Field has a value Channel statistics. See Period in consideration Follower count change for period in consideration total_viewcount/postcount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date). total_sharecount/postcount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date) total_reactions/postcount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date) total_views/storycount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date) total_shares/storycount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date) total_reactions/storycount, for posts posted during the period in consideration.
Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date) Percentage of subscribers with enabled notifications Channel growth graph (absolute subscriber count) Followers growth graph (relative subscriber count) Muted users graph (relative) Views per hour graph (absolute) Interactions graph (absolute) IV interactions graph (absolute) Views by source graph (absolute) New followers by source graph (absolute) Subscriber language graph (pie chart) A graph containing the number of reactions on posts categorized by emotion A graph containing the number of story views and shares A graph containing the number of reactions on stories categorized by emotion Detailed statistics about number of views and shares of recently sent messages and stories Info about pinned MTProxy or Public Service Announcement peers. See Derived classes: , No PSA/MTProxy info is available See Re-fetch PSA/MTProxy info after the specified number of seconds MTProxy/Public Service Announcement information See Extra bits of information, use flags.HasFlag(...) to test for those Expiry of PSA/MTProxy info MTProxy/PSA peer Chat info User info PSA type PSA message MTProxy-related channel Field has a value Field has a value returns a or for the result Represents an animated video thumbnail See Derived classes: , , An animated profile picture in MPEG4 format See Extra bits of information, use flags.HasFlag(...) to test for those u for animated profile pictures, and v for trimmed and downscaled video previews Video width Video height File size Timestamp that should be shown as static preview to the user (seconds) Field has a value An animated profile picture based on a custom emoji sticker. See Custom emoji ID: the custom emoji sticker is shown at the center of the profile picture and occupies at most 67% of it. 1, 2, 3 or 4 RBG-24 colors used to generate a solid (1), gradient (2) or freeform gradient (3, 4) background, similar to how fill wallpapers are generated. The rotation angle for gradient backgrounds is 0. An animated profile picture based on a sticker. See Stickerset Sticker ID 1, 2, 3 or 4 RBG-24 colors used to generate a solid (1), gradient (2) or freeform gradient (3, 4) background, similar to how fill wallpapers are generated. The rotation angle for gradient backgrounds is 0. Information about an active user in a supergroup See User ID Number of messages for statistics period in consideration Average number of characters per message Information about an active admin in a supergroup See User ID Number of deleted messages for statistics period in consideration Number of kicked users for statistics period in consideration Number of banned users for statistics period in consideration Information about an active supergroup inviter See User ID Number of invitations for statistics period in consideration Supergroup statistics See Period in consideration Member count change for period in consideration Message number change for period in consideration Number of users that viewed messages, for range in consideration Number of users that posted messages, for range in consideration Supergroup growth graph (absolute subscriber count) Members growth (relative subscriber count) New members by source graph Subscriber language graph (pie chart) Message activity graph (stacked bar graph, message type) Group activity graph (deleted, modified messages, blocked users) Activity per hour graph (absolute) Activity per day of week graph (absolute) Info about most active group members Info about most active group admins Info about most active group inviters Info about users mentioned in statistics Global privacy settings See Extra bits of information, use flags.HasFlag(...) to test for those Whether to archive and mute new chats from non-contacts Whether unmuted chats will be kept in the Archive chat list when they get a new message. Whether unmuted chats that are always included or pinned in a folder, will be kept in the Archive chat list when they get a new message. Ignored if keep_archived_unmuted is set. If this flag is set, the key will also apply to the ability to use Messages_GetOutboxReadDate on messages sent to us.
Meaning, users that cannot see our exact last online date due to the current value of the key will receive a 403 USER_PRIVACY_RESTRICTED error when invoking Messages_GetOutboxReadDate to fetch the exact read date of a message they sent to us.
The .read_dates_private flag will be set for users that have this flag enabled. If set, only users that have a premium account, are in our contact list, or already have a private chat with us can write to us; a 403 PRIVACY_PREMIUM_REQUIRED error will be emitted otherwise.
The .contact_require_premium flag will be set for users that have this flag enabled.
To check whether we can write to a user with this flag enabled, if we haven't yet cached all the required information (for example we don't have the or history of all users while displaying the chat list in the sharing UI) the Users_GetIsPremiumRequiredToContact method may be invoked, passing the list of users currently visible in the UI, returning a list of booleans that directly specify whether we can or cannot write to each user.
Premium users only, non-Premium users will receive a PREMIUM_ACCOUNT_REQUIRED error when trying to enable this flag. Country code and phone number pattern of a specific country See Extra bits of information, use flags.HasFlag(...) to test for those ISO country code Possible phone prefixes Phone patterns: for example, XXX XXX XXX Field has a value Field has a value Name, ISO code, localized name and phone codes/patterns of a specific country See Extra bits of information, use flags.HasFlag(...) to test for those ISO code of country Name of the country in the country's language Name of the country in the user's language, if different from the original name Phone codes/patterns Whether this country should not be shown in the list Field has a value Name, ISO code, localized name and phone codes/patterns of all available countries See a value means help.countriesListNotModified Name, ISO code, localized name and phone codes/patterns of all available countries Hash used for caching, for more info click here View, forward counter + info about replies of a specific message See Extra bits of information, use flags.HasFlag(...) to test for those View count of message Forward count of message Reply and thread information of message Field has a value Field has a value Field has a value View, forward counter + info about replies See View, forward counter + info about replies Chats mentioned in constructor Users mentioned in constructor returns a or for the given Peer Information about a message thread See Extra bits of information, use flags.HasFlag(...) to test for those The messages from which the thread starts. The messages are returned in reverse chronological order (i.e., in order of decreasing message ID). Message ID of latest reply in this thread Message ID of latest read incoming message in this thread Message ID of latest read outgoing message in this thread Number of unread messages Chats mentioned in constructor Users mentioned in constructor Field has a value Field has a value Field has a value returns a or for the given Peer Reply information See Derived classes: , Message replies and thread information See Extra bits of information, use flags.HasFlag(...) to test for those ID of message to which this message is replying For replies sent in channel discussion threads of which the current user is not a member, the discussion group ID When replying to a message sent by a certain peer to another chat, contains info about the peer that originally sent the message to that other chat. When replying to a media sent by a certain peer to another chat, contains the media of the replied-to message. ID of the message that started this message thread Used to quote-reply to only a certain section (specified here) of the original message. Message entities for styled text from the quote_text field. Offset of the message quote_text within the original message (in UTF-16 code units). Field has a value Field has a value This is a reply to a scheduled message. Whether this message was sent in a forum topic (except for the General topic). Field has a value Field has a value Field has a value Field has a value Field has a value Whether this message is quoting a part of another message. Field has a value Represents a reply to a story See Sender of the story. Story ID Info about the comment section of a channel post, or a simple message thread See Extra bits of information, use flags.HasFlag(...) to test for those Contains the total number of replies in this thread or comment section. PTS of the message that started this thread. For channel post comments, contains information about the last few comment posters for a specific thread, to show a small list of commenter profile pictures in client previews. For channel post comments, contains the ID of the associated discussion supergroup ID of the latest message in this thread or comment section. Contains the ID of the latest read message in this thread or comment section. Whether this constructor contains information about the comment section of a channel post, or a simple message thread Field has a value Field has a value Field has a value Information about a blocked peer See Peer ID When was the peer blocked Message statistics See Message view graph A graph containing the number of reactions on stories categorized by emotion A group call See Derived classes: , Group call ID Group call access hash An ended group call See Group call ID Group call access hash Group call duration Group call ID Group call access hash Info about a group call or livestream See Extra bits of information, use flags.HasFlag(...) to test for those Group call ID Group call access hash Participant count Group call title DC ID to be used for livestream chunks When was the recording started When is the call scheduled to start Number of people currently streaming video into the call Maximum number of people allowed to stream video into the call Version Whether the user should be muted upon joining the call Whether the current user can change the value of the join_muted flag using Phone_ToggleGroupCallSettings Field has a value Field has a value Field has a value Specifies the ordering to use when locally sorting by date and displaying in the UI group call participants. Field has a value Whether we subscribed to the scheduled call Whether you can start streaming video into the call Field has a value Whether the group call is currently being recorded Whether RTMP streams are allowed Whether the listeners list is hidden and cannot be fetched using Phone_GetGroupParticipants. The phone.groupParticipants.count and groupCall.participants_count counters will still include listeners. Group call ID Group call access hash Points to a specific group call See Group call ID ⚠ REQUIRED FIELD. See how to obtain it
Group call access hash Info about a group call participant See Extra bits of information, use flags.HasFlag(...) to test for those Peer information When did this participant join the group call When was this participant last active in the group call Source ID Volume, if not set the volume is set to 100%. Info about this participant Specifies the UI visualization order of peers with raised hands: peers with a higher rating should be showed first in the list. Info about the video stream the participant is currently broadcasting Info about the screen sharing stream the participant is currently broadcasting Whether the participant is muted Whether the participant has left Whether the participant can unmute themselves Field has a value Whether the participant has just joined If set, and .version < locally stored call.version, info about this participant should be ignored. If (...), and .version > call.version+1, the participant list should be refetched using Phone_GetGroupParticipants. Field has a value Field has a value If not set, the volume and muted_by_you fields can be safely used to overwrite locally cached information; otherwise, volume will contain valid information only if volume_by_admin is set both in the cache and in the received constructor. Whether this participant was muted by the current user Whether our volume can only changed by an admin Field has a value Whether this participant is the current user Field has a value Field has a value Whether this participant is currently broadcasting video Contains info about a group call, and partial info about its participants. See Info about the group call A partial list of participants. Next offset to use when fetching the remaining participants using Phone_GetGroupParticipants Chats mentioned in the participants vector Users mentioned in the participants vector returns a or for the given Peer Info about the participants of a group call or livestream See Number of participants List of participants If not empty, the specified list of participants is partial, and more participants can be fetched specifying this parameter as offset in Phone_GetGroupParticipants. Mentioned chats Mentioned users Version info returns a or for the given Peer Inline query peer type. See Peer type: private chat with the bot itself Peer type: private chat Peer type: chat Peer type: supergroup Peer type: channel Peer type: private chat with a bot. ID of a specific chat import session, click here for more info ». See History import ID Contains information about a chat export file generated by a foreign chat app, click here for more info.
If neither the pm or group flags are set, the specified chat export was generated from a chat of unknown type. See Extra bits of information, use flags.HasFlag(...) to test for those Title of the chat. The chat export file was generated from a private chat. The chat export file was generated from a group chat. Field has a value Messages found and affected by changes See Affected message IDs When and which user joined the chat using a chat invite See Extra bits of information, use flags.HasFlag(...) to test for those The user When did the user join For users with pending requests, contains bio of the user that requested to join The administrator that approved the join request » of the user Whether this user currently has a pending join request » Field has a value Field has a value The participant joined by importing a chat folder deep link ». Info about chat invites exported by a certain admin. See Number of invites exported by the admin Exported invites Info about the admin Contains info about a chat invite, and eventually a pointer to the newest chat invite. See Derived classes: , Info about the chat invite Mentioned users Info about a chat invite See Info about the chat invite Mentioned users Info about the chat invite Mentioned users The specified chat invite was replaced with another one See The replaced chat invite The invite that replaces the previous invite Mentioned users The replaced chat invite Mentioned users Info about the users that joined the chat using a specific chat invite See Number of users that joined The users that joined The users that joined Info about chat invites generated by admins. See The admin Number of invites generated by the admin Number of revoked invites Info about chat invites generated by admins. See Info about chat invites generated by admins. Mentioned users Contains a confirmation text to be shown to the user, upon importing chat history, click here for more info ». See A confirmation text to be shown to the user, upon importing chat history ». A list of peers that can be used to join a group call, presenting yourself as a specific user/channel. See Peers Chats mentioned in the peers vector Users mentioned in the peers vector returns a or for the given Peer An invite to a group call or livestream See Invite link Describes a group of video synchronization source identifiers See SDP semantics Source IDs Info about a video stream See Extra bits of information, use flags.HasFlag(...) to test for those Endpoint Source groups Audio source ID Whether the stream is currently paused Field has a value A suggested short name for a stickerpack See Suggested short name Represents a scope where the bot commands, specified using Bots_SetBotCommands will be valid. See Derived classes: , , , , , a value means botCommandScopeDefault The specified bot commands will only be valid in all private chats with users. See The specified bot commands will be valid in all groups and supergroups. See The specified bot commands will be valid only for chat administrators, in all groups and supergroups. See The specified bot commands will be valid only in a specific dialog. See The dialog The specified bot commands will be valid for all admins of the specified group or supergroup. See The specified bot commands will be valid only for a specific user in the specified group or supergroup. See The user Result of an Account_ResetPassword request. See Derived classes: , , You recently requested a password reset that was canceled, please wait until the specified date before requesting another reset. See Wait until this date before requesting another reset. You successfully requested a password reset, please wait until the specified date before finalizing the reset. See Wait until this date before finalizing the reset. The 2FA password was reset successfully. See A sponsored message. See Extra bits of information, use flags.HasFlag(...) to test for those Message ID Contains the URL to open when the user clicks on the sponsored message. Contains the title of the sponsored message. Sponsored message Message entities for styled text in message. If set, contains a custom profile photo bubble that should be displayed for the sponsored message, like for messages sent in groups. If set, contains some media. If set, the sponsored message should use the message accent color » specified in color. Label of the sponsored message button. If set, contains additional information about the sponsor to be shown along with the message. If set, contains additional information about the sponsored message to be shown along with the message. Field has a value Whether the message needs to be labeled as "recommended" instead of "sponsored" Field has a value Field has a value Field has a value Whether this message can be reported as specified here ». Field has a value Field has a value A set of sponsored messages associated to a channel See a value means messages.sponsoredMessagesEmpty Extra bits of information, use flags.HasFlag(...) to test for those If set, specifies the minimum number of messages between shown sponsored messages; otherwise, only one sponsored message must be shown after all ordinary messages. Sponsored messages Chats mentioned in the sponsored messages Users mentioned in the sponsored messages Field has a value returns a or for the given Peer Information about found messages sent on a specific day, used to split the messages in s by days. See The day this object is referring to. First message ID that was sent on this day. Last message ID that was sent on this day. All messages that were sent on this day. Information about found messages sent on a specific day See Extra bits of information, use flags.HasFlag(...) to test for those Total number of results matching query Starting timestamp of attached messages Ending timestamp of attached messages Indicates the absolute position of messages[0] within the total result set with count count.
This is useful, for example, if we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}. Used to split the messages by days: multiple constructors are returned, each containing information about the first, last and total number of messages matching the filter that were sent on a specific day.
This information can be easily used to split the returned messages by day. Messages Mentioned chats Mentioned users If set, indicates that the results may be inexact Field has a value returns a or for the given Peer Information about a message in a specific position See Derived classes: Information about a message in a specific position See Message ID When was the message sent 0-based message position in the full list of suitable messages Information about sparse positions of messages See Total number of found messages List of message positions A list of peers that can be used to send messages in a specific group See Peers that can be used to send messages to the group Mentioned chats Mentioned users returns a or for the given Peer Full user information See Full user information Mentioned chats Mentioned users returns a or for the given Peer Peer settings See Peer settings Mentioned chats Mentioned users returns a or for the given Peer Future auth token » to be used on subsequent authorizations See Extra bits of information, use flags.HasFlag(...) to test for those Future auth token » to be used on subsequent authorizations Field has a value Reactions See Extra bits of information, use flags.HasFlag(...) to test for those If set, indicates that the current user also sent this reaction.
The integer value indicates when was the reaction added: the bigger the value, the newer the reaction. The reaction. Number of users that reacted with this emoji. Field has a value Message reactions » See Extra bits of information, use flags.HasFlag(...) to test for those Reactions List of recent peers and their reactions Paid Telegram Star reactions leaderboard » for this message. Similar to min objects, used for message reaction » constructors that are the same for all users so they don't have the reactions sent by the current user (you can use Messages_GetMessagesReactions to get the full reaction info). Field has a value Whether Messages_GetMessageReactionsList can be used to see how each specific peer reacted to the message If set or if there are no reactions, all present and future reactions should be treated as message tags, see here » for more info. Field has a value List of peers that reacted to a specific message See Extra bits of information, use flags.HasFlag(...) to test for those Total number of reactions matching query List of peers that reacted to a specific message Mentioned chats Mentioned users If set, indicates the next offset to use to load more results by invoking Messages_GetMessageReactionsList. Field has a value returns a or for the given Peer Animations associated with a message reaction See Extra bits of information, use flags.HasFlag(...) to test for those Reaction emoji Reaction description Static icon for the reaction The animated sticker to show when the user opens the reaction dropdown The animated sticker to show when the user hovers over the reaction The animated sticker to show when the reaction is chosen and activated The background effect (still an animated sticker) to play under the activate_animation, when the reaction is chosen and activated The animation that plays around the button when you press an existing reaction (played together with center_icon). The animation of the emoji inside the button when you press an existing reaction (played together with around_animation). If not set, the reaction can be added to new messages and enabled in chats. Fields and have a value Whether this reaction can only be used by Telegram Premium users Animations and metadata associated with message reactions » See a value means messages.availableReactionsNotModified Hash used for caching, for more info click here Animations and metadata associated with message reactions » How a certain peer reacted to the message See Extra bits of information, use flags.HasFlag(...) to test for those Peer that reacted to the message When was this reaction added Reaction emoji Whether the specified message reaction » should elicit a bigger and longer reaction Whether the reaction wasn't yet marked as read by the current user Starting from layer 159, Messages_SendReaction will send reactions from the peer (user or channel) specified using Messages_SaveDefaultSendAs.
If set, this flag indicates that this reaction was sent by us, even if the peer doesn't point to the current account. Info about an RTMP stream in a group call or livestream See Channel ID Specifies the duration of the video segment to fetch in milliseconds, by bitshifting 1000 to the right scale times: duration_ms := 1000 >> scale. Last seen timestamp to easily start fetching livestream chunks using Info about RTMP streams in a group call or livestream See RTMP streams RTMP URL and stream key to be used in streaming software See RTMP URL Stream key Represents an attachment menu icon color for bot mini apps » See One of the following values:
light_icon - Color of the attachment menu icon (light mode)
light_text - Color of the attachment menu label, once selected (light mode)
dark_icon - Color of the attachment menu icon (dark mode)
dark_text - Color of the attachment menu label, once selected (dark mode) Color in RGB24 format Represents an attachment menu icon for bot mini apps » See Extra bits of information, use flags.HasFlag(...) to test for those One of the following values: note that animated icons must be played when the user clicks on the button, activating the bot mini app.

default_static - Default attachment menu icon in SVG format
placeholder_static - Default placeholder for opened Web Apps in SVG format
ios_static - Attachment menu icon in SVG format for the official iOS app
ios_animated - Animated attachment menu icon in TGS format for the official iOS app
android_animated - Animated attachment menu icon in TGS format for the official Android app
macos_animated - Animated attachment menu icon in TGS format for the official native Mac OS app
ios_side_menu_static - Side menu icon in PNG format for the official iOS app
android_side_menu_static - Side menu icon in SVG format for the official android app
macos_side_menu_static - Side menu icon in PNG format for the official native Mac OS app The actual icon file. Attachment menu icon colors. Field has a value Represents a bot mini app that can be launched from the attachment/side menu » See Extra bits of information, use flags.HasFlag(...) to test for those Bot ID Attachment menu item name List of dialog types where this attachment menu entry should be shown List of platform-specific static icons and animations to use for the attachment menu button If set, before launching the mini app the client should ask the user to add the mini app to the attachment/side menu, and only if the user accepts, after invoking Messages_ToggleBotInAttachMenu the app should be opened. Deprecated flag, can be ignored. Whether the bot would like to send messages to the user. Whether, when installed, an attachment menu entry should be shown for the Mini App. Whether, when installed, an entry in the main view side menu should be shown for the Mini App. If inactive if set and the user hasn't previously accepted the third-party mini apps Terms of Service for this bot, when showing the mini app installation prompt, an additional mandatory checkbox to accept the mini apps TOS and a disclaimer indicating that this Mini App is not affiliated to Telegram should be shown. Represents a list of bot mini apps that can be launched from the attachment menu » See a value means attachMenuBotsNotModified Hash used for caching, for more info click here List of bot mini apps that can be launched from the attachment menu » Info about related users/bots Represents a bot mini app that can be launched from the attachment menu » See Represents a bot mini app that can be launched from the attachment menu »
 Info about related users and bots Contains the webview URL with appropriate theme and user info parameters added See Derived classes: Contains the webview URL with appropriate theme and user info parameters added See Extra bits of information, use flags.HasFlag(...) to test for those Webview session ID (only returned by inline button mini apps, menu button mini apps, attachment menu mini apps). Webview URL to open Field has a value If set, the app must be opened in fullsize mode instead of compact mode. Info about a sent inline webview message See Extra bits of information, use flags.HasFlag(...) to test for those Message ID Field has a value Indicates the action to execute when pressing the in-UI menu button for bots See Derived classes: , a value means botMenuButtonDefault Bot menu button that opens the bot command list when clicked. See Bot menu button that opens a web app when clicked. See Title to be displayed on the menu button instead of 'Menu' URL of a web app to open when the user clicks on the button A list of saved notification sounds See a value means account.savedRingtonesNotModified Hash used for caching, for more info click here Saved notification sounds Represents a notification sound See Derived classes: , , a value means notificationSoundDefault No notification sound should be used See Indicates a specific local notification sound should be used See Notification sound title Notification sound identifier (arbitrary data used by the client to identify a specific local notification sound) A specific previously uploaded notification sound should be used See Document ID of notification sound uploaded using Account_UploadRingtone The notification sound was already in MP3 format and was saved without any modification See The notification sound was not in MP3 format and was successfully converted and saved, use the returned to refer to the notification sound from now on See The converted notification sound Indicates a supported peer type for a bot mini app attachment menu See The bot attachment menu entry is available in the chat with the bot that offers it The bot attachment menu entry is available in private chats with other bots (excluding the bot that offers the current attachment menu) The bot attachment menu entry is available in private chats with other users (not bots) The bot attachment menu entry is available in groups and supergroups The bot attachment menu entry is available in channels An invoice See Derived classes: , , , , , An invoice contained in a message or paid media ». See Chat where the invoice/paid media was sent Message ID An invoice slug taken from an invoice deep link or from the premium_invoice_slug app config parameter » See The invoice slug Used if the user wishes to start a channel/supergroup giveaway or send some giftcodes to members of a channel/supergroup, in exchange for boosts. See Should be populated with for giveaways and for gifts. Should be populated with one of the giveaway options returned by Payments_GetPremiumGiftCodeOptions, see the giveaways » documentation for more info. Used to top up the Telegram Stars balance of the current account or someone else's account, or to start a Telegram Star giveaway ». See An , or . Used to pay for a Telegram Star subscription ». See The invitation link of the Telegram Star subscription » Used to buy a Telegram Star Gift, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the user that will receive the gift Identifier of the gift, from .id Optional message, attached with the gift If set, your name will be hidden if the destination user decides to display the gift on their profile (they will still see that you sent the gift) Field has a value Exported invoice deep link See Exported invoice deep link Transcribed text from a voice message » See Extra bits of information, use flags.HasFlag(...) to test for those Transcription ID Transcripted text For non-Premium users, this flag will be set, indicating the remaining transcriptions in the free trial period. For non-Premium users, this flag will be set, indicating the date when the trial_remains_num counter will be reset to the maximum value of transcribe_audio_trial_weekly_number. Whether the transcription is partial because audio transcription is still in progress, if set the user may receive further updates with the updated transcription. Fields and have a value Telegram Premium promotion information See Description of the current state of the user's Telegram Premium subscription Message entities for styled text A list of premium feature identifiers », associated to each video A list of videos Telegram Premium subscription options Related user information Info about a Telegram Premium purchase See Derived classes: , , , , , , Info about a Telegram Premium purchase See Extra bits of information, use flags.HasFlag(...) to test for those Pass true if this is a restore of a Telegram Premium purchase; only for the App Store Pass true if this is an upgrade from a monthly subscription to a yearly subscription; only for App Store Info about a gifted Telegram Premium purchase See The user to which the Telegram Premium subscription was gifted Three-letter ISO 4217 currency code Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Used to gift Telegram Premium subscriptions only to some specific subscribers of a channel/supergroup or to some of our contacts, see here » for more info on giveaways and gifts. See Extra bits of information, use flags.HasFlag(...) to test for those The users that will receive the Telegram Premium subscriptions. If set, the gifts will be sent on behalf of a channel/supergroup we are an admin of, which will also assign some boosts to it. Otherwise, the gift will be sent directly from the currently logged in user, and we will gain some extra boost slots. See here » for more info on giveaways and gifts. Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Message attached with the gift Field has a value Field has a value Used to pay for a giveaway, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those The channel/supergroup starting the giveaway, that the user must join to participate, that will receive the giveaway boosts; see here » for more info on giveaways. Additional channels that the user must join to participate to the giveaway can be specified here. The set of users that can participate to the giveaway can be restricted by passing here an explicit whitelist of up to giveaway_countries_max countries, specified as two-letter ISO 3166-1 alpha-2 country codes. Can contain a textual description of additional giveaway prizes. Random ID to avoid resending the giveaway The end date of the giveaway, must be at most giveaway_period_max seconds in the future; see here » for more info on giveaways. Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway. Field has a value Field has a value If set, giveaway winners are public and will be listed in a message that will be automatically sent to the channel once the giveaway ends. Field has a value Used to top up the Telegram Stars balance of the current account. See Amount of stars to topup Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Used to gift Telegram Stars to a friend. See The user to which the stars should be gifted. Amount of stars to gift Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Used to pay for a star giveaway, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of Telegram Stars being given away (each user will receive stars/users stars). The channel/supergroup starting the giveaway, that the user must join to participate, that will receive the giveaway boosts; see here » for more info on giveaways. Additional channels that the user must join to participate to the giveaway can be specified here. The set of users that can participate to the giveaway can be restricted by passing here an explicit whitelist of up to giveaway_countries_max countries, specified as two-letter ISO 3166-1 alpha-2 country codes. Can contain a textual description of additional giveaway prizes. Random ID to avoid resending the giveaway The end date of the giveaway, must be at most giveaway_period_max seconds in the future; see here » for more info on giveaways. Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Number of winners. If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway. Field has a value Field has a value If set, giveaway winners are public and will be listed in a message that will be automatically sent to the channel once the giveaway ends. Field has a value Telegram Premium gift option See Extra bits of information, use flags.HasFlag(...) to test for those Duration of gifted Telegram Premium subscription Three-letter ISO 4217 currency code Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). An invoice deep link » to an invoice for in-app payment, using the official Premium bot; may be empty if direct payment isn't available. An identifier for the App Store/Play Store product associated with the Premium gift. Field has a value Represents an additional payment method See URL to open in a webview to process the payment Payment method description An emoji status See a value means emojiStatusEmpty Custom emoji document ID An emoji status valid until the specified date See This status is valid until this date A list of emoji statuses See a value means account.emojiStatusesNotModified Hash used for caching, for more info click here Emoji statuses Message reaction See Derived classes: , , a value means reactionEmpty Normal emoji message reaction See Emoji Custom emoji message reaction See Custom emoji document ID Represents a paid Telegram Star reaction ». See Available chat reactions See Derived classes: , a value means chatReactionsNone All reactions or all non-custom reactions are allowed See Extra bits of information, use flags.HasFlag(...) to test for those Whether to allow custom reactions Some reactions are allowed See Allowed set of reactions: the reactions_in_chat_max configuration field indicates the maximum number of reactions that can be specified in this field. List of message reactions See a value means messages.reactionsNotModified Hash used for caching, for more info click here Reactions Email verification purpose See Derived classes: , , Email verification purpose: setup login email See Phone number Phone code hash as specified by the documentation Email verification purpose: change login email See Verify an email for use in telegram passport See Email verification code or token See Derived classes: , , Email verification code See Received verification code Google ID email verification token See Token Apple ID email verification token See Token The email was verified correctly. See The verified email address. The email was verified correctly, and a login code was just sent to it. See Info about the sent login code Describes a Telegram Premium subscription option See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the last in-store transaction for the currently used subscription on the current account. Duration of subscription in months Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Deep link used to initiate payment Store product ID, only for official apps Field has a value Whether this subscription option is currently in use. Whether this subscription option can be used to upgrade the existing Telegram Premium subscription. When upgrading Telegram Premium subscriptions bought through stores, make sure that the store transaction ID is equal to transaction, to avoid upgrading someone else's account, if the client is currently logged into multiple accounts. Field has a value Indicates a peer that can be used to send messages See Extra bits of information, use flags.HasFlag(...) to test for those Peer Whether a Telegram Premium account is required to send messages as this peer Paid media, see here » for more info. See Derived classes: , Paid media preview for not yet purchased paid media, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Width Height Extremely low resolution thumbnail. Video duration for videos. Fields and have a value Field has a value Field has a value Already purchased paid media, see here » for more info. See The media we purchased. Keywords for a certain sticker See Sticker ID Keywords Contains information about a username. See Extra bits of information, use flags.HasFlag(...) to test for those The username. Whether the username is editable, meaning it wasn't bought on fragment. Whether the username is active. Contains information about a forum topic See Derived classes: , The ID of the deleted forum topic. Represents a deleted forum topic. See The ID of the deleted forum topic. The ID of the deleted forum topic. Represents a forum topic. See Extra bits of information, use flags.HasFlag(...) to test for those Topic ID Topic creation date Topic title If no custom emoji icon is specified, specifies the color of the fallback topic icon (RGB), one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F. ID of the custom emoji used as topic icon. ID of the last message that was sent to this topic Position up to which all incoming messages are read. Position up to which all outgoing messages are read. Number of unread messages Number of unread mentions Number of unread reactions to messages you sent ID of the peer that created the topic Notification settings Message draft Field has a value Whether the topic was created by the current user Whether the topic is closed (no messages can be sent to it) Whether the topic is pinned Field has a value Whether this constructor is a reduced version of the full topic information.
If set, only the my, closed, id, date, title, icon_color, icon_emoji_id and from_id parameters will contain valid information.
Reduced info is usually only returned in topic-related admin log events » and in the : if needed, full information can be fetched using Channels_GetForumTopicsByID. Whether the topic is hidden (only valid for the "General" topic, id=1) Topic ID Contains information about multiple forum topics See Extra bits of information, use flags.HasFlag(...) to test for those Total number of topics matching query; may be more than the topics contained in topics, in which case pagination is required. Forum topics Related messages (contains the messages mentioned by .top_message). Related chats Related users Event count after generation Whether the returned topics are ordered by creation date; if set, pagination by offset_date should use .date; otherwise topics are ordered by the last message date, so paginate by the date of the referenced by .top_message. returns a or for the given Peer Contains info about the default value of the Time-To-Live setting, applied to all new chats. See Time-To-Live setting applied to all new chats. Describes a temporary profile link. See The temporary profile link. Its expiration date Filtering criteria to use for the peer selection list shown to the user. See Derived classes: , , Choose a user. See Extra bits of information, use flags.HasFlag(...) to test for those Whether to allow choosing only bots. Whether to allow choosing only Premium users. Field has a value Field has a value Choose a chat or supergroup See Extra bits of information, use flags.HasFlag(...) to test for those If specified, allows only choosing channels with or without a username, according to the value of . If specified, allows only choosing chats or supergroups that are or aren't forums, according to the value of . If specified, allows only choosing chats or supergroups where the current user is an admin with at least the specified admin rights. If specified, allows only choosing chats or supergroups where the bot is an admin with at least the specified admin rights. Whether to allow only choosing chats or supergroups that were created by the current user. Field has a value Field has a value Field has a value Field has a value Whether to allow only choosing chats or supergroups where the bot is a participant. Choose a channel See Extra bits of information, use flags.HasFlag(...) to test for those If specified, allows only choosing channels with or without a username, according to the value of . If specified, allows only choosing channels where the current user is an admin with at least the specified admin rights. If specified, allows only choosing channels where the bot is an admin with at least the specified admin rights. Whether to allow only choosing channels that were created by the current user. Field has a value Field has a value Field has a value Represents a list of custom emojis. See a value means emojiListNotModified Hash used for caching, for more info click here Custom emoji IDs Represents an emoji category. See Derived classes: , , Category name, i.e. "Animals", "Flags", "Faces" and so on... A single custom emoji used as preview for the category. Represents an emoji category. See Category name, i.e. "Animals", "Flags", "Faces" and so on... A single custom emoji used as preview for the category. A list of UTF-8 emojis, matching the category. Category name, i.e. "Animals", "Flags", "Faces" and so on... A single custom emoji used as preview for the category. Represents an emoji category, that should be moved to the top of the list when choosing a sticker for a business introduction See An emoji category, used to select all Premium-only stickers (i.e. those with a Premium effect »)/Premium-only custom emojis (i.e. those where the .free flag is not set) See Category name, i.e. "Animals", "Flags", "Faces" and so on... A single custom emoji used as preview for the category. Category name, i.e. "Animals", "Flags", "Faces" and so on... A single custom emoji used as preview for the category. Represents a list of emoji categories. See a value means messages.emojiGroupsNotModified Hash used for caching, for more info click here A list of emoji categories. Styled text with message entities See Text Message entities for styled text Translated text with entities. See Derived classes: Translated text with entities See Text+entities, for each input message. Media autosave settings See Extra bits of information, use flags.HasFlag(...) to test for those If set, specifies a size limit for autosavable videos Whether photos should be autosaved to the gallery. Whether videos should be autosaved to the gallery. Field has a value Peer-specific media autosave settings See The peer Media autosave settings Contains media autosave settings See Default media autosave settings for private chats Default media autosave settings for groups and supergroups Default media autosave settings for channels Peer-specific granular autosave settings Chats mentioned in the peer-specific granular autosave settings Users mentioned in the peer-specific granular autosave settings returns a or for the given Peer Contains various client configuration parameters See a value means help.appConfigNotModified Hash used for caching, for more info click here Client configuration parameters Used to fetch information about a direct link Mini App See Derived classes: , Used to fetch information about a direct link Mini App by its ID See direct link Mini App ID. ⚠ REQUIRED FIELD. See how to obtain it
Access hash, obtained from the . Used to fetch information about a direct link Mini App by its short name See ID of the bot that owns the bot mini app Short name, obtained from a Direct Mini App deep link Contains information about a direct link Mini App. See a value means botAppNotModified Extra bits of information, use flags.HasFlag(...) to test for those bot mini app ID bot mini app access hash bot mini app short name, used to generate Direct Mini App deep links. bot mini app title. bot mini app description. bot mini app photo. bot mini app animation. Hash to pass to Messages_GetBotApp, to avoid refetching bot app info if it hasn't changed. Field has a value Contains information about a direct link Mini App See Extra bits of information, use flags.HasFlag(...) to test for those Bot app information Whether the web app was never used by the user, and confirmation must be asked from the user before opening it. The bot is asking permission to send messages to the user: if the user agrees, set the write_allowed flag when invoking Messages_RequestAppWebView. Deprecated flag, can be ignored. Specifies an inline mode mini app button, shown on top of the inline query results list. See Text of the button Webapp URL Contains info about when a certain participant has read a message See User ID When the user read the message Represents a folder See Derived classes: Folder ID See Folder ID Exported chat folder deep link ». See Extra bits of information, use flags.HasFlag(...) to test for those Name of the link The chat folder deep link ». Peers to import Info about an exported chat folder deep link ». See Folder ID The exported chat folder deep link ». Info about multiple chat folder deep links ». See The chat folder deep links ». Related chat information Related user information returns a or for the given Peer Info about a chat folder deep link ». See Derived classes: , Related chat information Related user information Updated info about a chat folder deep link » we already imported. See ID of the imported folder New peers to be imported Peers that were already imported Related chat information Related user information Related chat information Related user information returns a or for the given Peer Info about a chat folder deep link ». See Extra bits of information, use flags.HasFlag(...) to test for those Name of the link Emoji to use as icon for the folder. Supergroups and channels to join Related chat information Related user information Field has a value Related chat information Related user information returns a or for the given Peer Updated information about a chat folder deep link ». See New peers to join Related chat information Related user information returns a or for the given Peer Localized information about a bot. See Bot name Bot about text Bot description How a user voted in a poll See Derived classes: , , Peer ID When did the peer cast the vote How a peer voted in a poll See Peer ID The option chosen by the peer When did the peer cast the vote Peer ID When did the peer cast the vote How a peer voted in a poll (reduced constructor, returned if an option was provided to Messages_GetPollVotes) See The peer that voted for the queried option When did the peer cast the vote The peer that voted for the queried option When did the peer cast the vote How a peer voted in a multiple-choice poll See Peer ID Options chosen by the peer When did the peer cast their votes Peer ID When did the peer cast their votes Aggregated view and reaction information of a story. See Extra bits of information, use flags.HasFlag(...) to test for those View counter of the story Forward counter of the story All reactions sent to this story Number of reactions added to the story User IDs of some recent viewers of the story Field has a value If set, indicates that the viewers list is currently viewable, and was not yet deleted because the story has expired while the user didn't have a Premium account. Field has a value Field has a value Field has a value Represents a Telegram Story See Derived classes: , , Story ID Represents a previously active story, that was deleted See Story ID Story ID Represents an active story, whose full information was omitted for space and performance reasons; use Stories_GetStoriesByID to fetch full info about the skipped story when and if needed. See Extra bits of information, use flags.HasFlag(...) to test for those Story ID When was the story posted. When does the story expire. Whether this story can only be viewed by our close friends, see here » for more info Story ID Represents a story. See Extra bits of information, use flags.HasFlag(...) to test for those ID of the story. When was the story posted. Sender of the story. For reposted stories », contains info about the original story. When does the story expire. Story caption. Message entities for styled text Story media. List of media areas, see here » for more info on media areas. Privacy rules indicating who can and can't view this story View date and reaction information The reaction we sent. Field has a value Field has a value Field has a value Field has a value Whether this story is pinned on the user's profile Whether this story is public and can be viewed by everyone Whether this story can only be viewed by our close friends, see here » for more info Full information about this story was omitted for space and performance reasons; use Stories_GetStoriesByID to fetch full info about this story when and if needed. Whether this story is protected and thus cannot be forwarded; clients should also prevent users from saving attached media (i.e. videos should only be streamed, photos should be kept in RAM, et cetera). Indicates whether the story was edited. Whether this story can only be viewed by our contacts Whether this story can only be viewed by a select list of our contacts Field has a value Field has a value indicates whether we sent this story. Field has a value Field has a value ID of the story. Full list of active (or active and hidden) stories. See Derived classes: , The list of active (or active and hidden) stories has not changed. See Extra bits of information, use flags.HasFlag(...) to test for those State to use to ask for updates Current stealth mode information Full list of active (or active and hidden) stories. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of active (or active and hidden) stories State to use for pagination Stories Mentioned chats Mentioned users Current stealth mode information Whether more results can be fetched as described here ». returns a or for the given Peer List of stories See Extra bits of information, use flags.HasFlag(...) to test for those Total number of stories that can be fetched Stories IDs of pinned stories. Mentioned chats Mentioned users Field has a value returns a or for the given Peer Story view date and reaction information See Derived classes: , , Story view date and reaction information See Extra bits of information, use flags.HasFlag(...) to test for those The user that viewed the story When did the user view the story If present, contains the reaction that the user left on the story Whether we have completely blocked this user, including from viewing more of our stories. Whether we have blocked this user from viewing more of our stories. Field has a value A certain peer has forwarded the story as a message to a public chat or channel. See Extra bits of information, use flags.HasFlag(...) to test for those The message with the forwarded story. Whether we have completely blocked this user, including from viewing more of our stories. Whether we have blocked this user from viewing more of our stories. A certain peer has reposted the story. See Extra bits of information, use flags.HasFlag(...) to test for those The peer that reposted the story. The reposted story. Whether we have completely blocked this user, including from viewing more of our stories. Whether we have blocked this user from viewing more of our stories. Reaction and view counters for a story See Extra bits of information, use flags.HasFlag(...) to test for those Total number of results that can be fetched Total number of story views Total number of story forwards/reposts Number of reactions that were added to the story Story view date and reaction information Mentioned chats Mentioned users Offset for pagination Field has a value returns a or for the given Peer Reaction and view counters for a list of stories See View date and reaction information of multiple stories Mentioned users Contains info about a message or story to reply to. See Derived classes: , Reply to a message. See Extra bits of information, use flags.HasFlag(...) to test for those The message ID to reply to. This field must contain the topic ID only when replying to messages in forum topics different from the "General" topic (i.e. reply_to_msg_id is set and reply_to_msg_id != topicID and topicID != 1).
If the replied-to message is deleted before the method finishes execution, the value in this field will be used to send the message to the correct topic, instead of the "General" topic. Used to reply to messages sent to another chat (specified here), can only be used for non-protected chats and messages. Used to quote-reply to only a certain section (specified here) of the original message. The maximum UTF-8 length for quotes is specified in the quote_length_max config key. Message entities for styled text from the quote_text field. Offset of the message quote_text within the original message (in UTF-16 code units). Field has a value Field has a value Field has a value Field has a value Field has a value Reply to a story. See Sender of the story ID of the story to reply to. Represents a story deep link. See The story deep link. Information about the current stealth mode session. See Extra bits of information, use flags.HasFlag(...) to test for those The date up to which stealth mode will be active. The date starting from which the user will be allowed to re-enable stealth mode again. Field has a value Field has a value Coordinates and size of a clicable rectangular area on top of a story. See Extra bits of information, use flags.HasFlag(...) to test for those The abscissa of the rectangle's center, as a percentage of the media width (0-100). The ordinate of the rectangle's center, as a percentage of the media height (0-100). The width of the rectangle, as a percentage of the media width (0-100). The height of the rectangle, as a percentage of the media height (0-100). Clockwise rotation angle of the rectangle, in degrees (0-360). The radius of the rectangle corner rounding, as a percentage of the media width. Field has a value Represents a story media area » See Derived classes: , , , , , , , Represents a location tag attached to a story, with additional venue information. See The size and location of the media area corresponding to the location sticker on top of the story media. Coordinates of the venue Venue name Address Venue provider: currently only "foursquare" needs to be supported. Venue ID in the provider's database Venue type in the provider's database Represents a location tag attached to a story, with additional venue information. See The size and location of the media area corresponding to the location sticker on top of the story media. The query_id from , see here » for more info. The id of the chosen result, see here » for more info. Represents a geolocation tag attached to a story. See Extra bits of information, use flags.HasFlag(...) to test for those The size and position of the media area corresponding to the location sticker on top of the story media. Coordinates of the geolocation tag. Optional textual representation of the address. Field has a value Represents a reaction bubble. See Extra bits of information, use flags.HasFlag(...) to test for those The coordinates of the media area corresponding to the reaction button. The reaction that should be sent when this area is clicked. Whether the reaction bubble has a dark background. Whether the reaction bubble is mirrored (see here » for more info). Represents a channel post. See The size and location of the media area corresponding to the location sticker on top of the story media. The channel that posted the message ID of the channel message Represents a channel post See The size and location of the media area corresponding to the location sticker on top of the story media. The channel that posted the message ID of the channel message Represents a URL media area. See The size and location of the media area corresponding to the URL button on top of the story media. URL to open when clicked. Represents a weather widget ». See The size and location of the media area corresponding to the widget on top of the story media. Weather emoji, should be rendered as an animated emoji. Temperature in degrees Celsius. ARGB background color. Stories associated to a peer See Extra bits of information, use flags.HasFlag(...) to test for those The peer If set, contains the ID of the maximum read story Stories Field has a value Active story list of a specific peer. See Stories Mentioned chats Mentioned users returns a or for the given Peer Represents an Instant View webpage. See The instant view webpage. Chats mentioned in the webpage. Users mentioned in the webpage. returns a or for the given Peer Contains info about a giveaway/gift option. See Extra bits of information, use flags.HasFlag(...) to test for those Number of users which will be able to activate the gift codes. Duration in months of each gifted Telegram Premium subscription. Identifier of the store product associated with the option, official apps only. Number of times the store product must be paid Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Field has a value Field has a value Contains info about a Telegram Premium giftcode link. See Extra bits of information, use flags.HasFlag(...) to test for those The peer that created the gift code. Message ID of the giveaway in the channel specified in from_id. The destination user of the gift. Creation date of the gift code. Duration in months of the gifted Telegram Premium subscription. When was the giftcode imported, if it was imported. Mentioned chats Mentioned users Field has a value Field has a value Whether this giftcode was created by a giveaway. Field has a value Field has a value returns a or for the given Peer Info about a Telegram Premium Giveaway. See Derived classes: , When was the giveaway started Contains info about an ongoing giveaway. See Extra bits of information, use flags.HasFlag(...) to test for those When was the giveaway started The current user can't participate in the giveaway, because they were already a member of the channel when the giveaway started, and the only_new_subscribers was set when starting the giveaway. If set, the current user can't participate in the giveaway, because they are an administrator in one of the channels (ID specified in this flag) that created the giveaway. If set, the current user can't participate in this giveaway, because their phone number is from the specified disallowed country (specified as a two-letter ISO 3166-1 alpha-2 country code). The current user is participating in the giveaway. Field has a value Field has a value If set, the giveaway has ended and the results are being prepared. Field has a value When was the giveaway started A giveaway has ended. See Extra bits of information, use flags.HasFlag(...) to test for those Start date of the giveaway If we're one of the winners of this giveaway, contains the Premium gift code, see here » for more info on the full giveaway flow. If we're one of the winners of this Telegram Star giveaway, the number Telegram Stars we won. End date of the giveaway. May be bigger than the end date specified in parameters of the giveaway. Number of winners in the giveaway Number of winners, which activated their gift codes. Whether we're one of the winners of this giveaway. Whether the giveaway was canceled and was fully refunded. Field has a value Field has a value Field has a value Start date of the giveaway Contains info about a prepaid giveaway ». See Derived classes: , Prepaid giveaway ID. Number of given away Telegram Premium subscriptions. Payment date. Contains info about a prepaid giveaway ». See Prepaid giveaway ID. Duration in months of each gifted Telegram Premium subscription. Number of given away Telegram Premium subscriptions. Payment date. Prepaid giveaway ID. Number of given away Telegram Premium subscriptions. Payment date. Contains info about a prepaid Telegram Star giveaway ». See Prepaid giveaway ID. Number of given away Telegram Stars » Number of giveaway winners Number of boosts the channel will gain by launching the giveaway. When was the giveaway paid for Prepaid giveaway ID. Number of giveaway winners When was the giveaway paid for Info about one or more boosts applied by a specific user. See Extra bits of information, use flags.HasFlag(...) to test for those Unique ID for this set of boosts. ID of the user that applied the boost. The message ID of the giveaway When was the boost applied When does the boost expire The created Telegram Premium gift code, only set if either gift or giveaway are set AND it is either a gift code for the currently logged in user or if it was already claimed. If set, this boost counts as multiplier boosts, otherwise it counts as a single boost. Field has a value Whether this boost was applied because the channel/supergroup directly gifted a subscription to the user. Whether this boost was applied because the user was chosen in a giveaway started by the channel/supergroup. If set, the user hasn't yet invoked Payments_ApplyGiftCode to claim a subscription gifted directly or in a giveaway by the channel. Field has a value Field has a value Field has a value List of boosts that were applied to a peer by multiple users. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of results Boosts Offset that can be used for pagination. Mentioned users Field has a value Contains information about a single boost slot ». See Extra bits of information, use flags.HasFlag(...) to test for those Boost slot ID » If set, indicates this slot is currently occupied, i.e. we are boosting this peer.
Note that we can assign multiple boost slots to the same peer. When (unixtime) we started boosting the peer, 0 otherwise. Indicates the (unixtime) expiration date of the boost in peer (0 if peer is not set). If peer is set, indicates the (unixtime) date after which this boost can be reassigned to another channel. Field has a value Field has a value A list of peers we are currently boosting, and how many boost slots we have left. See Info about boosted peers and remaining boost slots. Referenced chats Referenced users returns a or for the given Peer Contains info about the current boost status of a peer. See Extra bits of information, use flags.HasFlag(...) to test for those The current boost level of the channel/supergroup. The number of boosts acquired so far in the current level. Total number of boosts acquired so far. The number of boosts acquired from created Telegram Premium gift codes and giveaways; only returned to channel/supergroup admins. Total number of boosts needed to reach the next level; if absent, the next level isn't available. Only returned to channel/supergroup admins: contains the approximated number of Premium users subscribed to the channel/supergroup, related to the total number of subscribers. Boost deep link » that can be used to boost the chat. A list of prepaid giveaways available for the chat; only returned to channel/supergroup admins. Indicates which of our boost slots we've assigned to this peer (populated if my_boost is set). Field has a value Field has a value Whether we're currently boosting this channel/supergroup, my_boost_slots will also be set. Field has a value Field has a value Contains info about the original poster of a reposted story. See Extra bits of information, use flags.HasFlag(...) to test for those Peer that originally posted the story; will be empty for stories forwarded from a user with forwards privacy enabled, in which case from_name will be set, instead. Will be set for stories forwarded from a user with forwards privacy enabled, in which case from will also be empty. , contains the story ID Field has a value Field has a value Field has a value Whether the story media was modified before reposting it (for example by overlaying a round video with a reaction). Interaction counters See Derived classes: , Number of views Number of forwards to public channels Number of reactions Interaction counters for a message. See Message ID Interaction counters for a story. See Story ID Contains statistics about a story. See A graph containing the number of story views and shares A bar graph containing the number of story reactions categorized by "emotion" (i.e. Positive, Negative, Other, etc...) Contains info about the forwards of a story as a message to public chats and reposts by public channels. See Derived classes: , Contains info about a forward of a story as a message. See Info about the message with the reposted story. Contains info about a forward of a story as a repost by a public channel. See The channel that reposted the story. The reposted story (may be different from the original story). Contains info about the forwards of a story as a message to public chats and reposts by public channels. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of results Info about the forwards of a story. Offset used for pagination. Mentioned chats Mentioned users Field has a value returns a or for the given Peer Represents a color palette ». See Extra bits of information, use flags.HasFlag(...) to test for those Color palette ID, see here » for more info; if not set, the default palette should be used. Optional custom emoji ID used to generate the pattern. Field has a value Field has a value Contains info about a color palette ». See Derived classes: , Represents a color palette that can be used in message accents ». See A list of 1-3 colors in RGB format, describing the accent color. Represents a color palette that can be used in profile pages ». See A list of 1-2 colors in RGB format, shown in the color palette settings to describe the current palette. A list of 1-2 colors in RGB format describing the colors used to generate the actual background used in the profile page. A list of 2 colors in RGB format describing the colors of the gradient used for the unread active story indicator around the profile photo. Contains info about a color palette ». See Extra bits of information, use flags.HasFlag(...) to test for those Palette ID. Light mode palette.
Will be empty for IDs 0 to 6 inclusive, in which case a palette containing a single color from the following colors should be used: red, orange, violet, green, cyan, blue, pink for indexes 0 to 6 (i.e. the same colors used for randomized fallback message accent colors). Dark mode palette. Optional, defaults to the palette in colors (or the autogenerated palette for IDs 0 to 6) if absent. Channels can use this palette only after reaching at least the boost level specified in this field. Supergroups can use this palette only after reaching at least the boost level specified in this field. Whether this palette should not be displayed as an option to the user when choosing a palette to apply to profile pages or message accents. Field has a value Field has a value Field has a value Field has a value Contains info about multiple color palettes ». See a value means help.peerColorsNotModified Hash used for caching, for more info click here Usable color palettes. How a certain peer reacted to or interacted with a story See Derived classes: , , How a certain peer reacted to a story See The peer Reaction date The reaction A certain peer has forwarded the story as a message to a public chat or channel. See The message with the forwarded story. A certain peer has reposted the story. See The peer that reposted the story. The reposted story. List of peers that reacted to or intercated with a specific story See Extra bits of information, use flags.HasFlag(...) to test for those Total number of reactions matching query List of peers that reacted to or interacted with a specific story Mentioned chats Mentioned users If set, indicates the next offset to use to load more results by invoking Stories_GetStoryReactionsList. Field has a value returns a or for the given Peer Represents a saved dialog ». See Extra bits of information, use flags.HasFlag(...) to test for those The dialog The latest message ID Is the dialog pinned Represents some saved message dialogs ». See Derived classes: , , Saved message dialogs ». List of last messages from each saved dialog Mentioned chats Mentioned users Represents some saved message dialogs ». See Saved message dialogs ». List of last messages from each saved dialog Mentioned chats Mentioned users Saved message dialogs ». List of last messages from each saved dialog Mentioned chats Mentioned users returns a or for the given Peer Incomplete list of saved message dialogs » with messages and auxiliary data. See Total number of saved message dialogs The saved dialogs haven't changed See Number of saved dialogs found server-side by the query Info about a saved message reaction tag ». See Extra bits of information, use flags.HasFlag(...) to test for those Reaction associated to the tag. Custom tag name assigned by the user (max 12 UTF-8 chars). Number of messages tagged with this tag. Field has a value List of reaction tag » names assigned by the user. See a value means messages.savedReactionTagsNotModified Saved reaction tags. Hash used for caching, for more info click here Exact read date of a private message we sent to another user. See UNIX timestamp with the read date. SMS jobs eligibility See Derived classes: SMS jobs eligibility See Terms of service URL Monthly sent SMSes Status See Extra bits of information, use flags.HasFlag(...) to test for those Recently sent Since Remaining Total sent Total since Last gift deep link Terms of service URL Allow international numbers Field has a value Info about an SMS job. See Job ID Destination phone number Text A time interval, indicating the opening hours of a business. See Start minute in minutes of the week, 0 to 7*24*60 inclusively. End minute in minutes of the week, 1 to 8*24*60 inclusively (8 and not 7 because this allows to specify intervals that, for example, start on Sunday 21:00 and end on Monday 04:00 (6*24*60+21*60 to 7*24*60+4*60) without passing an invalid end_minute < start_minute). See here » for more info. Specifies a set of Telegram Business opening hours. See Extra bits of information, use flags.HasFlag(...) to test for those An ID of one of the timezones returned by Help_GetTimezonesList.
The timezone ID is contained .id, a human-readable, localized name of the timezone is available in .name and the .utc_offset field contains the UTC offset in seconds, which may be displayed in hh:mm format by the client together with the human-readable name (i.e. $name UTC -01:00). A list of time intervals (max 28) represented by businessWeeklyOpen », indicating the opening hours of their business. Ignored if set while invoking Account_UpdateBusinessWorkHours, only returned by the server in .business_work_hours, indicating whether the business is currently open according to the current time and the values in weekly_open and timezone. Represents the location of a Telegram Business ». See Extra bits of information, use flags.HasFlag(...) to test for those Geographical coordinates (optional). Textual description of the address (mandatory). Field has a value Specifies the chats that can receive Telegram Business away » and greeting » messages. See Extra bits of information, use flags.HasFlag(...) to test for those Only private chats with the specified users. All existing private chats. All new private chats. All private chats with contacts. All private chats with non-contacts. Field has a value If set, inverts the selection. Specifies the chats that can receive Telegram Business away » and greeting » messages. See Extra bits of information, use flags.HasFlag(...) to test for those Only private chats with the specified users. All existing private chats. All new private chats. All private chats with contacts. All private chats with non-contacts. Field has a value If set, inverts the selection. Specifies when should the Telegram Business away messages be sent. See Derived classes: , , Always send Telegram Business away messages to users writing to us in private. See Send Telegram Business away messages to users writing to us in private outside of the configured Telegram Business working hours. See Send Telegram Business away messages to users writing to us in private in the specified time span. See Start date (UNIX timestamp). End date (UNIX timestamp). Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period. See ID of a quick reply shorcut, containing the greeting messages to send, see here » for more info. Allowed recipients for the greeting messages. The number of days after which a private chat will be considered as inactive; currently, must be one of 7, 14, 21, or 28. Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period. See ID of a quick reply shorcut, containing the greeting messages to send, see here » for more info. Allowed recipients for the greeting messages. The number of days after which a private chat will be considered as inactive; currently, must be one of 7, 14, 21, or 28. Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user. See Extra bits of information, use flags.HasFlag(...) to test for those ID of a quick reply shorcut, containing the away messages to send, see here » for more info. Specifies when should the away messages be sent. Allowed recipients for the away messages. If set, the messages will not be sent if the account was online in the last 10 minutes. Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user. See Extra bits of information, use flags.HasFlag(...) to test for those ID of a quick reply shorcut, containing the away messages to send, see here » for more info. Specifies when should the away messages be sent. Allowed recipients for the away messages. If set, the messages will not be sent if the account was online in the last 10 minutes. Timezone information. See Unique timezone ID. Human-readable and localized timezone name. UTC offset in seconds, which may be displayed in hh:mm format by the client together with the human-readable name (i.e. $name UTC -01:00). Timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours ». See a value means help.timezonesListNotModified Timezones Hash used for caching, for more info click here A quick reply shortcut. See Unique shortcut ID. Shortcut name. ID of the last message in the shortcut. Total number of messages in the shortcut. Represents a quick reply shortcut ». See Derived classes: , Selects a quick reply shortcut by name. See Shortcut name. Selects a quick reply shortcut by its numeric ID. See Shortcut ID. Info about quick reply shortcuts ». See a value means messages.quickRepliesNotModified Quick reply shortcuts. Messages mentioned in quick_replies. Mentioned chats Mentioned users returns a or for the given Peer Contains info about a connected business bot ». See Extra bits of information, use flags.HasFlag(...) to test for those ID of the connected bot Specifies the private chats that a connected business bot » may receive messages and interact with.
 Whether the the bot can reply to messages it receives through the connection Info about currently connected business bots. See Info about the connected bots Bot information Folder and folder tags information See Extra bits of information, use flags.HasFlag(...) to test for those Folders. Whether folder tags are enabled. Birthday information for a user. See Extra bits of information, use flags.HasFlag(...) to test for those Birth day Birth month (Optional) birth year. Field has a value Contains info about a bot business connection. See Extra bits of information, use flags.HasFlag(...) to test for those Business connection ID, used to identify messages coming from the connection and to reply to them as specified here ». ID of the user that the bot is connected to via this connection. ID of the datacenter where to send queries wrapped in a InvokeWithBusinessConnection as specified here ». When was the connection created. Whether the bot can reply on behalf of the user to messages it receives through the business connection Whether this business connection is currently disabled Telegram Business introduction ». See Extra bits of information, use flags.HasFlag(...) to test for those Title of the introduction message Profile introduction Optional introduction sticker. Field has a value Telegram Business introduction ». See Extra bits of information, use flags.HasFlag(...) to test for those Title of the introduction message (max intro_title_length_limit » UTF-8 characters). Profile introduction (max intro_description_length_limit » UTF-8 characters). Optional introduction sticker. Field has a value The list of stickersets owned by the current account ». See Total number of owned stickersets. Stickersets Represents a Fragment collectible ». See Derived classes: , Represents a username fragment collectible See Username Represents a phone number fragment collectible See Phone number Info about a fragment collectible. See Purchase date (unixtime) Three-letter ISO 4217 currency code for amount Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Cryptocurrency name. Price, in the smallest units of the cryptocurrency. Fragment URL with more info about the collectible Specifies the private chats that a connected business bot » may interact with. See Extra bits of information, use flags.HasFlag(...) to test for those Explicitly selected private chats. Identifiers of private chats that are always excluded. Selects all existing private chats. Selects all new private chats. Selects all private chats with contacts. Selects all private chats with non-contacts. Field has a value If set, then all private chats except the ones selected by existing_chats, new_chats, contacts, non_contacts and users are chosen.
Note that if this flag is set, any values passed in exclude_users will be merged and moved into users by the server. Field has a value Specifies the private chats that a connected business bot » may receive messages and interact with. See Extra bits of information, use flags.HasFlag(...) to test for those Explicitly selected private chats. Identifiers of private chats that are always excluded. Selects all existing private chats. Selects all new private chats. Selects all private chats with contacts. Selects all private chats with non-contacts. Field has a value If set, then all private chats except the ones selected by existing_chats, new_chats, contacts, non_contacts and users are chosen.
Note that if this flag is set, any values passed in exclude_users will be merged and moved into users by the server, thus exclude_users will always be empty. Field has a value Birthday information of a contact. See User ID. Birthday information. Birthday information of our contacts. See Birthday info User information Info about why a specific user could not be invited ». See Extra bits of information, use flags.HasFlag(...) to test for those ID of the user. If neither of the flags below are set, we could not add the user because of their privacy settings, and we can create and directly share an invite link with them using a normal message, instead. If set, we could not add the user only because the current account needs to purchase a Telegram Premium subscription to complete the operation. If set, we could not add the user because of their privacy settings, and additionally, the current account needs to purchase a Telegram Premium subscription to directly share an invite link with the user via a private message. Contains info about successfully or unsuccessfully invited » users. See List of updates about successfully invited users (and eventually info about the created group) A list of users that could not be invited, along with the reason why they couldn't be invited. Contains info about a business chat deep link » to be created by the current account. See Extra bits of information, use flags.HasFlag(...) to test for those Message to pre-fill in the message input field. Message entities for styled text Human-readable name of the link, to simplify management in the UI (only visible to the creator of the link). Field has a value Field has a value Contains info about a business chat deep link » created by the current account. See Extra bits of information, use flags.HasFlag(...) to test for those Business chat deep link. Message to pre-fill in the message input field. Message entities for styled text Human-readable name of the link, to simplify management in the UI (only visible to the creator of the link). Number of times the link was resolved (clicked/scanned/etc...). Field has a value Field has a value Contains info about business chat deep links » created by the current account. See Links Mentioned chats Mentioned users returns a or for the given Peer Contains info about a single resolved business chat deep link ». See Extra bits of information, use flags.HasFlag(...) to test for those Destination peer Message to pre-fill in the message input field. Message entities for styled text Mentioned chats Mentioned users Field has a value returns a or for the result Info about a peer, shared by a user with the currently logged in bot using Messages_SendBotRequestedPeer. See Derived classes: , , Info about a user, shared by a user with the currently logged in bot using Messages_SendBotRequestedPeer. See Extra bits of information, use flags.HasFlag(...) to test for those User ID. First name. Last name. Username. Profile photo. Fields and have a value Field has a value Field has a value Info about a chat, shared by a user with the currently logged in bot using Messages_SendBotRequestedPeer. See Extra bits of information, use flags.HasFlag(...) to test for those Chat ID. Chat title. Chat photo. Field has a value Field has a value Info about a channel/supergroup, shared by a user with the currently logged in bot using Messages_SendBotRequestedPeer. See Extra bits of information, use flags.HasFlag(...) to test for those Channel/supergroup ID. Channel/supergroup title. Channel/supergroup username. Channel/supergroup photo. Field has a value Field has a value Field has a value A report option for a sponsored message ». See Localized description of the option. Option identifier to pass to Channels_ReportSponsoredMessage. Status of the method call used to report a sponsored message ». See Derived classes: , , The user must choose a report option from the localized options available in options, and after selection, Channels_ReportSponsoredMessage must be invoked again, passing the option's option field to the option param of the method. See Title of the option selection popup. Localized list of options. Sponsored messages were hidden for the user in all chats. See The sponsored message was reported successfully. See Channel revenue ad statistics, see here » for more info. See Ad impressions graph Ad revenue graph (in the smallest unit of the cryptocurrency in which revenue is calculated) Current balance, current withdrawable balance and overall revenue Current conversion rate of the cryptocurrency (not in the smallest unit) in which revenue is calculated to USD Contains the URL to use to withdraw channel ad revenue. See A unique URL to a Fragment page where the user will be able to specify and submit the address of the TON wallet where the funds will be sent. A channel ad revenue » transaction. See Derived classes: , , Describes earnings from sponsored messages in a channel in some time frame, see here » for more info. See Amount in the smallest unit of the cryptocurrency. Start unixtime for the timeframe. End unixtime for the timeframe. Describes a withdrawal of ad earnings » See Extra bits of information, use flags.HasFlag(...) to test for those Amount withdrawn Withdrawal date Payment provider name If neither pending nor failed are set, the transaction was completed successfully, and this field will contain the point in time (Unix timestamp) when the withdrawal was completed successfully. If neither pending nor failed are set, the transaction was completed successfully, and this field will contain a URL where the withdrawal transaction can be viewed. Whether the withdrawal is currently pending Fields and have a value Whether the withdrawal has failed Describes a refund for failed withdrawal of ad earnings » See Amount refunded. Date of refund. Payment provider name. Channel ad revenue transactions ». See Total number of transactions. Transactions Reaction notification settings See Receive notifications about reactions made only by our contacts. Receive notifications about reactions made by any user. Reaction notification settings, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Message reaction notification settings, if not set completely disables notifications/updates about message reactions. Story reaction notification settings, if not set completely disables notifications/updates about reactions to stories. Notification sound for reactions » If false, push notifications » about message/story reactions will only be of type REACT_HIDDEN/REACT_STORY_HIDDEN, without any information about the reacted-to story or the reaction itself. Field has a value Field has a value Describes channel ad revenue balances ». See Extra bits of information, use flags.HasFlag(...) to test for those Amount of not-yet-withdrawn cryptocurrency. Amount of withdrawable cryptocurrency, out of the currently available balance (available_balance <= current_balance). Total amount of earned cryptocurrency. If set, the available balance can be withdrawn ». Represents a message effect ». See Extra bits of information, use flags.HasFlag(...) to test for those Unique effect ID. Emoji corresponding to the effect, to be used as icon for the effect if static_icon_id is not set. ID of the document containing the static icon (WEBP) of the effect. Contains the preview animation (TGS format »), used for the effect selection menu. If set, contains the actual animated effect (TGS format »). If not set, the animated effect must be set equal to the premium animated sticker effect associated to the animated sticker specified in effect_sticker_id (always different from the preview animation, fetched thanks to the of type f as specified here »). Field has a value Field has a value Whether a Premium subscription is required to use this effect. The full list of usable animated message effects ». See a value means messages.availableEffectsNotModified Hash used for caching, for more info click here Message effects Documents specified in the effects constructors. Represents a fact-check » created by an independent fact-checker. See Extra bits of information, use flags.HasFlag(...) to test for those A two-letter ISO 3166-1 alpha-2 country code of the country for which the fact-check should be shown. The fact-check. Hash used for caching, for more info click here If set, the country/text fields will not be set, and the fact check must be fetched manually by the client (if it isn't already cached with the key specified in hash) using bundled Messages_GetFactCheck requests, when the message with the factcheck scrolls into view. Fields and have a value Source of an incoming Telegram Star transaction, or its recipient for outgoing Telegram Star transactions. See Derived classes: , , , , , , , Describes a Telegram Star transaction that cannot be described using the current layer. See Describes a Telegram Star transaction with the App Store, used when purchasing Telegram Stars through the App Store. See Describes a Telegram Star transaction with the Play Store, used when purchasing Telegram Stars through the Play Store. See Describes a Telegram Star transaction made using @PremiumBot (i.e. using the flow described here »). See Describes a Telegram Star transaction with Fragment, used when purchasing Telegram Stars through Fragment. See Describes a Telegram Star transaction with another peer. See The peer. Describes a Telegram Star transaction used to pay for Telegram ads as specified here ». See Describes a Telegram Star transaction used to pay for paid API usage, such as paid bot broadcasts. See Telegram Stars topup option. See Extra bits of information, use flags.HasFlag(...) to test for those Amount of Telegram stars. Identifier of the store product associated with the option, official apps only. Three-letter ISO 4217 currency code Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Field has a value If set, the option must only be shown in the full list of topup options. Represents a Telegram Stars transaction ». See Extra bits of information, use flags.HasFlag(...) to test for those Transaction ID. Amount of Stars (negative for outgoing transactions). Date of the transaction (unixtime). Source of the incoming transaction, or its recipient for outgoing transactions. For transactions with bots, title of the bought product. For transactions with bots, description of the bought product. For transactions with bots, photo of the bought product. If neither pending nor failed are set, the transaction was completed successfully, and this field will contain the point in time (Unix timestamp) when the withdrawal was completed successfully. If neither pending nor failed are set, the transaction was completed successfully, and this field will contain a URL where the withdrawal transaction can be viewed. Bot specified invoice payload (i.e. the payload passed to when creating the invoice). For paid media transactions », message ID of the paid media posted to peer.peer (can point to a deleted message; either way, extended_media will always contain the bought media). The purchased paid media ». The number of seconds between consecutive Telegram Star debiting for Telegram Star subscriptions ». ID of the message containing the , for incoming star giveaway prizes. This transaction indicates a purchase or a sale (conversion back to Stars) of a gift ». This transaction is payment for paid bot broadcasts.
Paid broadcasts are only allowed if the allow_paid_floodskip parameter of Messages_SendMessage and other message sending methods is set while trying to broadcast more than 30 messages per second to bot users.
The integer value returned by this flag indicates the number of billed API calls. Field has a value Field has a value Field has a value Whether this transaction is a refund. The transaction is currently pending. Fields and have a value This transaction has failed. Field has a value Field has a value Field has a value This transaction was a gift from the user in peer.peer. This transaction is a paid reaction ». Field has a value Field has a value Field has a value Field has a value Field has a value Fields and have a value Info about the current Telegram Star subscriptions, balance and transaction history ». See Extra bits of information, use flags.HasFlag(...) to test for those Current Telegram Star balance. Info about current Telegram Star subscriptions, only returned when invoking Payments_GetStarsTransactions and Payments_GetStarsSubscriptions. Offset for pagination of subscriptions: only usable with Payments_GetStarsSubscriptions, returned when invoking Payments_GetStarsTransactions and Payments_GetStarsSubscriptions. The number of Telegram Stars the user should buy to be able to extend expired subscriptions soon (i.e. the current balance is not enough to extend all expired subscriptions). List of Telegram Star transactions (partial if next_offset is set). Offset to use to fetch more transactions from the transaction history using Payments_GetStarsTransactions. Chats mentioned in history. Users mentioned in history. Field has a value Field has a value Field has a value Field has a value Field has a value returns a or for the given Peer A story found using global story search ». See The peer that posted the story. The story. Stories found using global story search ». See Extra bits of information, use flags.HasFlag(...) to test for those Total number of results found for the query. Matching stories. Offset used to fetch the next page, if not set this is the final page. Mentioned chats Mentioned users Field has a value returns a or for the given Peer Address optionally associated to a . See Extra bits of information, use flags.HasFlag(...) to test for those Two-letter ISO 3166-1 alpha-2 country code State City Street Field has a value Field has a value Field has a value Describes Telegram Star revenue balances ». See Extra bits of information, use flags.HasFlag(...) to test for those Amount of not-yet-withdrawn Telegram Stars. Amount of withdrawable Telegram Stars. Total amount of earned Telegram Stars. Unixtime indicating when will withdrawal be available to the user. If not set, withdrawal can be started now. If set, the user may withdraw up to available_balance stars. Field has a value Star revenue statistics, see here » for more info. See Star revenue graph (number of earned stars) Current balance, current withdrawable balance and overall earned Telegram Stars Current conversion rate of Telegram Stars to USD Contains the URL to use to withdraw Telegram Star revenue. See Contains the URL to use to withdraw Telegram Star revenue. Contains a URL leading to a page where the user will be able to place ads for the channel/bot, paying using Telegram Stars. See URL to open. Used to fetch info about a Telegram Star transaction ». See Extra bits of information, use flags.HasFlag(...) to test for those Transaction ID. If set, fetches info about the refund transaction for this transaction. Telegram Stars gift option. See Extra bits of information, use flags.HasFlag(...) to test for those Amount of Telegram stars. Identifier of the store product associated with the option, official apps only. Three-letter ISO 4217 currency code Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Field has a value If set, the option must only be shown in the full list of topup options. Popular Main Mini Apps, to be used in the apps tab of global search ». See Extra bits of information, use flags.HasFlag(...) to test for those Offset for pagination. The bots associated to each Main Mini App, see here » for more info. Field has a value Represents a Main Mini App preview media, see here » for more info. See When was this media last updated. The actual photo/video. Contains info about Main Mini App previews, see here » for more info. See All preview medias for the language code passed to Bots_GetPreviewInfo. All available language codes for which preview medias were uploaded (regardless of the language code passed to Bots_GetPreviewInfo). Pricing of a Telegram Star subscription ». See The user should pay amount stars every period seconds to gain and maintain access to the channel.
Currently the only allowed subscription period is 30*24*60*60, i.e. the user will be debited amount stars every month. Price of the subscription in Telegram Stars. Represents a Telegram Star subscription ». See Extra bits of information, use flags.HasFlag(...) to test for those Subscription ID. Identifier of the associated private chat. Expiration date of the current subscription period. Pricing of the subscription in Telegram Stars. Invitation link, used to renew the subscription after cancellation or expiration. Whether this subscription was cancelled. Whether we left the associated private channel, but we can still rejoin it using Payments_FulfillStarsSubscription because the current subscription period hasn't expired yet. Whether this subscription has expired because there are not enough stars on the user's balance to extend it. Field has a value Field has a value Field has a value Field has a value Info about a user in the paid Star reactions leaderboard for a message. See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the peer that reacted: may be unset for anonymous reactors different from the current user (i.e. if the current user sent an anonymous reaction anonymous will be set but this field will also be set). The number of sent Telegram Stars. If set, the reactor is one of the most active reactors; may be unset if the reactor is the current user. If set, this reactor is the current user. If set, the reactor is anonymous. Field has a value Contains info about a Telegram Star giveaway option. See Extra bits of information, use flags.HasFlag(...) to test for those The number of Telegram Stars that will be distributed among winners Number of times the chat will be boosted for one year if the .boost_peer flag is populated Identifier of the store product associated with the option, official apps only. Three-letter ISO 4217 currency code Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Allowed options for the number of giveaway winners. If set, this option must only be shown in the full list of giveaway options (i.e. they must be added to the list only when the user clicks on the expand button). If set, this option must be pre-selected by default in the option list. Field has a value Allowed options for the number of giveaway winners. See Extra bits of information, use flags.HasFlag(...) to test for those The number of users that will be randomly chosen as winners. The number of Telegram Stars each winner will receive. If set, this option must be pre-selected by default in the option list. Represents a star gift, see here » for more info. See Extra bits of information, use flags.HasFlag(...) to test for those Identifier of the gift Sticker that represents the gift. Price of the gift in Telegram Stars. For limited-supply gifts: the remaining number of gifts that may be bought. For limited-supply gifts: the total number of gifts that was available in the initial supply. The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.
convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars. For sold out gifts only: when was the gift first bought. For sold out gifts only: when was the gift last bought. Whether this is a limited-supply gift. Whether this gift sold out and cannot be bought anymore. Available gifts ». See a value means payments.starGiftsNotModified Hash used for caching, for more info click here List of available gifts. Represents a gift, displayed on a user's profile page. See Extra bits of information, use flags.HasFlag(...) to test for those Sender of the gift (may be empty for anonymous senders; will always be set if this gift was sent to us). When was this gift sent. The gift. Message attached to the gift by the sender. Only visible to the receiver of the gift, contains the ID of the with the in the chat with from_id. The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.
convert_stars will be equal to the buying price of the gift only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars. If set, from_id will not be visible to users (it will still be visible to the receiver of the gift). Field has a value Field has a value Field has a value Field has a value If set, indicates this is a gift sent by from_id, received by the current user and currently hidden from our profile page. Gifts displayed on a user's profile. See Extra bits of information, use flags.HasFlag(...) to test for those Total number of gifts displayed on the profile. The gifts. Offset for pagination. Users mentioned in the gifts vector. Field has a value Report menu option See Option title Option identifier: if the user selects this option, re-invoke Messages_Report, passing this option to option Represents a report menu or result See Derived classes: , , The user must choose one of the following options, and then Messages_Report must be re-invoked, passing the option's option identifier to Messages_Report.option. See Title of the option popup Available options, rendered as menu entries. The user should enter an additional comment for the moderators, and then Messages_Report must be re-invoked, passing the comment to Messages_Report.message. See Extra bits of information, use flags.HasFlag(...) to test for those The Messages_Report method must be re-invoked, passing this option to option Whether this step can be skipped by the user, passing an empty message to Messages_Report, or if a non-empty message is mandatory. The report was sent successfully, no further actions are required. See See See See See See See See See See See See Invokes a query after successful completion of one of the previous queries. See Message identifier on which a current query depends The query itself Invokes a query after a successful completion of previous queries See List of messages on which a current query depends The query itself Initialize connection See Possible codes: 400 (details) Application identifier (see. App configuration) Device model Operation system version Application version Code for the language used on the device's OS, ISO 639-1 standard Platform identifier (i.e. android, tdesktop, etc). Either an ISO 639-1 language code or a language pack name obtained from a language pack link. Info about an MTProto proxy Additional initConnection parameters.
For now, only the tz_offset field is supported, for specifying the timezone offset in seconds. The query itself Invoke the specified query using the specified API layer See Possible codes: 400,403,406 (details) The layer to use The query Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries). See The query Invoke with the given message range See Message range Query Invoke a method within a takeout session, see here » for more info. See Takeout session ID » Query Invoke a method using a Telegram Business Bot connection, see here » for more info, including a list of the methods that can be wrapped in this constructor. See Business connection ID. The actual query. Official clients only, invoke with Google Play Integrity token. See Nonce. Token. Query. Official clients only, invoke with Apple push verification. See Nonce. Secret. Query. Send the verification code for login See Possible codes: 400,406,500 (details) Phone number in international format Application identifier (see App configuration) Application secret hash (see App configuration) Settings for the code type to send Registers a validated phone number in the system. See Possible codes: 400,406 (details) If set, users on Telegram that have already added phone_number to their contacts will not receive signup notifications about this user. Phone number in the international format SMS-message ID New user first name New user last name Signs in a user with a validated phone number. See Possible codes: 400,406,500 (details) Phone number in the international format SMS-message ID, obtained from Auth_SendCode Valid numerical code from the SMS-message Email verification code or token Logs out the user. See [bots: ✓] Terminates all user's authorized sessions except for the current one. See Possible codes: 406 (details) Returns data for copying authorization to another data-center. See [bots: ✓] Possible codes: 400 (details) Number of a target data-center Logs in a user using a key transmitted from his native data-center. See [bots: ✓] Possible codes: 400 (details) User ID Authorization key Binds a temporary authorization key temp_auth_key_id to the permanent authorization key perm_auth_key_id. Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one. See [bots: ✓] Possible codes: 400 (details) Permanent auth_key_id to bind to Random long from Binding message contents Unix timestamp to invalidate temporary key, see Binding message contents See Generating encrypted_message Login as a bot See [bots: ✓] Possible codes: 400 (details) Reserved for future use Application identifier (see. App configuration) Application identifier hash (see. App configuration) Bot token (see bots) Try logging to an account protected by a 2FA password. See Possible codes: 400 (details) The account's password (see SRP) Request recovery code of a 2FA password, only for accounts with a recovery email configured. See Possible codes: 400 (details) Reset the 2FA password using the recovery code sent using Auth_RequestPasswordRecovery. See Possible codes: 400 (details) Code received via email New password Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info. See Possible codes: 400,406 (details) The phone number The phone code hash obtained from Auth_SendCode Official clients only, used if the device integrity verification failed, and no secret could be obtained to invoke Auth_RequestFirebaseSms: in this case, the device integrity verification failure reason must be passed here. Cancel the login verification code See Possible codes: 400,406 (details) Phone number Phone code hash from Auth_SendCode Delete all temporary authorization keys except for the ones specified See [bots: ✓] The auth keys that shouldn't be dropped. Generate a login token, for login via QR code.
The generated login token should be encoded using base64url, then shown as a tg://login?token=base64encodedtoken deep link » in the QR code. See Possible codes: 400 (details) Application identifier (see. App configuration) Application identifier hash (see. App configuration) List of already logged-in user IDs, to prevent logging in twice with the same user Login using a redirected login token, generated in case of DC mismatch during QR code login. See Possible codes: 400 (details) Login token Accept QR code login token, logging in the app that generated it. See Possible codes: 400 (details) Login token embedded in QR code, for more info, see login via QR code. Check if the 2FA recovery code sent using Auth_RequestPasswordRecovery is valid, before passing it to Auth_RecoverPassword. See Possible codes: 400 (details) Code received via email Login by importing an authorization token See Possible codes: 400 (details) API ID API hash The authorization token Request an SMS code via Firebase. See Possible codes: 400 (details) Phone number Phone code hash returned by Auth_SendCode On Android, a JWS object obtained as described in the auth documentation » On Android, an object obtained as described in the auth documentation » Secret token received via an apple push notification Reset the login email ». See Possible codes: 400 (details) Phone number of the account Phone code hash, obtained as described in the documentation » Official apps only, reports that the SMS authentication code wasn't delivered. See Possible codes: 400 (details) Phone number where we were supposed to receive the code The phone code hash obtained from Auth_SendCode MNC of the current network operator. Register device to receive PUSH notifications See Possible codes: 400 (details) Avoid receiving (silent and invisible background) notifications. Useful to save battery. Device token type, see PUSH updates for the possible values. Device token, see PUSH updates for the possible values. If is transmitted, a sandbox-certificate will be used during transmission. For FCM and APNS VoIP, optional encryption key used to encrypt push notifications List of user identifiers of other users currently using the client Deletes a device by its token, stops sending PUSH-notifications to it. See Possible codes: 400 (details) Device token type, see PUSH updates for the possible values. Device token, see PUSH updates for the possible values. List of user identifiers of other users currently using the client Edits notification settings from a given user/group, from all users/all groups. See Possible codes: 400 (details) Notification source Notification settings Gets current notification settings for a given user/group, from all users/all groups. See Possible codes: 400 (details) Notification source Resets all notification settings from users and groups. See Updates user profile. See Possible codes: 400 (details) New user first name New user last name New bio Updates online user status. See If is transmitted, user status will change to . Returns a list of available wallpapers. See Hash used for caching, for more info click here. a null value means account.wallPapersNotModified Report a peer for violation of telegram's Terms of Service See Possible codes: 400 (details) The peer to report The reason why this peer is being reported Comment for report moderation Validates a username and checks availability. See Possible codes: 400 (details) username
Accepted characters: A-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. Changes username for the current user. See Possible codes: 400 (details) username or empty string if username is to be removed
Accepted characters: a-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. Get privacy settings of current account See Possible codes: 400 (details) Peer category whose privacy settings should be fetched Change privacy settings of current account See Possible codes: 400 (details) New privacy rule Peers to which the privacy rule will apply. Delete the user's account from the telegram servers. See Possible codes: 420 (details) Why is the account being deleted, can be empty 2FA password: this field can be omitted even for accounts with 2FA enabled: in this case account account deletion will be delayed by 7 days as specified in the docs » Get days to live of account See Set account self-destruction period See Possible codes: 400 (details) Time to live in days Verify a new phone number to associate to the current account See Possible codes: 400,406 (details) New phone number Phone code settings Change the phone number of the current account See Possible codes: 400,406 (details) New phone number Phone code hash received when calling Account_SendChangePhoneCode Phone code received when calling Account_SendChangePhoneCode When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications. See Inactivity period after which to start hiding message texts in PUSH notifications. Get logged-in sessions See Log out an active authorized session by its hash See Possible codes: 400,406 (details) Session hash Obtain configuration for two-factor authorization with password See Get private info associated to the password info (recovery email, telegram passport info & so on) See Possible codes: 400 (details) The password (see SRP) Set a new 2FA password See Possible codes: 400 (details) The old password (see SRP) The new password (see SRP) Send confirmation code to cancel account deletion, for more info click here » See Possible codes: 400 (details) The hash from the service notification, for more info click here » Phone code settings Confirm a phone number to cancel account deletion, for more info click here » See Possible codes: 400 (details) Phone code hash, for more info click here » SMS code, for more info click here » Get temporary payment password See Possible codes: 400 (details) SRP password parameters Time during which the temporary password will be valid, in seconds; should be between 60 and 86400 Get web login widget authorizations See Log out an active web telegram login session See Possible codes: 400 (details) Session hash Reset all active web telegram login sessions See Get all saved Telegram Passport documents, for more info see the passport docs » See Get saved Telegram Passport document, for more info see the passport docs » See Requested value types Securely save Telegram Passport document, for more info see the passport docs » See Possible codes: 400 (details) Secure value, for more info see the passport docs » Passport secret hash, for more info see the passport docs » Delete stored Telegram Passport documents, for more info see the passport docs » See Document types to delete Returns a Telegram Passport authorization form for sharing data with a service See Possible codes: 400 (details) User identifier of the service's bot Telegram Passport element types requested by the service Service's public key Sends a Telegram Passport authorization form, effectively sharing data with the service See Possible codes: 400 (details) Bot ID Telegram Passport element types requested by the service Service's public key Types of values sent and their hashes Encrypted values Send the verification phone code for telegram passport. See Possible codes: 400 (details) The phone number to verify Phone code settings Verify a phone number for telegram passport. See Possible codes: 400 (details) Phone number Phone code hash received from the call to Account_SendVerifyPhoneCode Code received after the call to Account_SendVerifyPhoneCode Send an email verification code. See Possible codes: 400 (details) Verification purpose. The email where to send the code. Verify an email address. See Possible codes: 400 (details) Verification purpose Email verification code or token Initialize a takeout session, see here » for more info. See Possible codes: 420 (details) Whether to export contacts Whether to export messages in private chats Whether to export messages in basic groups Whether to export messages in supergroups Whether to export messages in channels Whether to export files Maximum size of files to export Terminate a takeout session, see here » for more info. See Possible codes: 403 (details) Data exported successfully Verify an email to use as 2FA recovery method. See Possible codes: 400 (details) The phone code that was received after setting a recovery email Resend the code to verify an email to use as 2FA recovery method. See Possible codes: 400 (details) Cancel the code that was sent to verify an email to use as 2FA recovery method. See Possible codes: 400 (details) Whether the user will receive notifications when contacts sign up See Toggle contact sign up notifications See Whether to disable contact sign up notifications Returns list of chats with non-default notification settings See If set, chats with non-default sound will be returned If set, chats with non-default notification settings for stories will be returned If specified, only chats of the specified category will be returned Get info about a certain wallpaper See Possible codes: 400 (details) The wallpaper to get info about Create and upload a new wallpaper See Possible codes: 400 (details) Set this flag when uploading wallpapers to be passed to Messages_SetChatWallPaper. The JPG/PNG wallpaper MIME type of uploaded wallpaper Wallpaper settings Install/uninstall wallpaper See Possible codes: 400 (details) Wallpaper to install or uninstall Uninstall wallpaper? Wallpaper settings Install wallpaper See Possible codes: 400 (details) Wallpaper to install Wallpaper settings Delete all installed wallpapers, reverting to the default wallpaper set. See Get media autodownload settings See Change media autodownload settings See Whether to save media in the low data usage preset Whether to save media in the high data usage preset Media autodownload settings Upload theme See Possible codes: 400 (details) Previously uploaded theme file with platform-specific colors for UI components, can be left unset when creating themes that only modify the wallpaper or accent colors. Thumbnail File name MIME type, must be application/x-tgtheme-{format}, where format depends on the client Create a theme See Possible codes: 400 (details) Unique theme ID used to generate theme deep links, can be empty to autogenerate a random ID. Theme name Theme file Theme settings, multiple values can be provided for the different base themes (day/night mode, etc). Update theme See Possible codes: 400 (details) Theme format, a string that identifies the theming engines supported by the client Theme to update Unique theme ID Theme name Theme file Theme settings Save a theme See Possible codes: 400 (details) Theme to save Unsave Install a theme See Whether to install the dark version Theme to install Theme format, a string that identifies the theming engines supported by the client Indicates a basic theme provided by all clients Get theme information See Possible codes: 400 (details) Theme format, a string that identifies the theming engines supported by the client Theme Get installed themes See Theme format, a string that identifies the theming engines supported by the client Hash used for caching, for more info click here. a null value means account.themesNotModified Set sensitive content settings (for viewing or hiding NSFW content) See Possible codes: 403 (details) Enable NSFW content Get sensitive content settings See Get info about multiple wallpapers See Possible codes: 400 (details) Wallpapers to fetch info about Get global privacy settings See Set global privacy settings See Possible codes: 400,403 (details) Global privacy settings Report a profile photo of a dialog See Possible codes: 400 (details) The dialog Dialog photo ID Report reason Comment for report moderation Initiate a 2FA password reset: can only be used if the user is already logged-in, see here for more info » See Possible codes: 400 (details) Abort a pending 2FA password reset, see here for more info » See Possible codes: 400 (details) Get all available chat themes ». See Hash used for caching, for more info click here. a null value means account.themesNotModified Set time-to-live of current session See Possible codes: 400,406 (details) Time-to-live of current session in days Change settings related to a session. See Possible codes: 400 (details) If set, confirms a newly logged in session ». Session ID from the , fetchable using Account_GetAuthorizations Whether to enable or disable receiving encrypted chats: if the flag is not set, the previous setting is not changed Whether to enable or disable receiving calls: if the flag is not set, the previous setting is not changed Fetch saved notification sounds See Hash used for caching, for more info click here. a null value means account.savedRingtonesNotModified Save or remove saved notification sound. See Possible codes: 400 (details) Notification sound uploaded using Account_UploadRingtone Whether to add or delete the notification sound Upload notification sound, use Account_SaveRingtone to convert it and add it to the list of saved notification sounds. See Possible codes: 400 (details) Notification sound File name MIME type of file Set an emoji status See Possible codes: 400 (details) Emoji status to set Get a list of default suggested emoji statuses See Hash used for caching, for more info click here. a null value means account.emojiStatusesNotModified Get recently used emoji statuses See Hash used for caching, for more info click here. a null value means account.emojiStatusesNotModified Clears list of recently used emoji statuses See Reorder usernames associated with the currently logged-in user. See Possible codes: 400 (details) The new order for active usernames. All active usernames must be specified. Activate or deactivate a purchased fragment.com username associated to the currently logged-in user. See Possible codes: 400 (details) Username Whether to activate or deactivate it Get a set of suggested custom emoji stickers that can be used as profile picture See Hash used for caching, for more info click here. a null value means emojiListNotModified Get a set of suggested custom emoji stickers that can be used as group picture See Hash used for caching, for more info click here. a null value means emojiListNotModified Get autosave settings See Modify autosave settings See Possible codes: 400 (details) Whether the new settings should affect all private chats Whether the new settings should affect all groups Whether the new settings should affect all channels Whether the new settings should affect a specific peer The new autosave settings Clear all peer-specific autosave settings. See Invalidate the specified login codes, see here » for more info. See The login codes to invalidate. Update the accent color and background custom emoji » of the current account. See Possible codes: 400,403 (details) Whether to change the accent color emoji pattern of the profile page; otherwise, the accent color and emoji pattern of messages will be changed. ID of the accent color palette » to use (not RGB24, see here » for more info). Custom emoji ID used in the accent color pattern. Get a set of suggested custom emoji stickers that can be used in an accent color pattern. See Hash used for caching, for more info click here. a null value means emojiListNotModified Get a list of default suggested channel emoji statuses. See Hash used for caching, for more info click here. a null value means account.emojiStatusesNotModified Returns fetch the full list of custom emoji IDs » that cannot be used in channel emoji statuses ». See Hash used for caching, for more info click here. a null value means emojiListNotModified Specify a set of Telegram Business opening hours.
This info will be contained in .business_work_hours. See Possible codes: 400 (details) Opening hours (optional, if not set removes all opening hours). Businesses » may advertise their location using this method, see here » for more info. See Optional, contains a set of geographical coordinates. Mandatory when setting/updating the location, contains a textual description of the address (max 96 UTF-8 chars). Set a list of Telegram Business greeting messages. See Greeting message configuration and contents. Set a list of Telegram Business away messages. See Away message configuration and contents. Connect a business bot » to the current account, or to change the current connection settings. See Possible codes: 400,403 (details) Whether the bot can reply to messages it receives from us, on behalf of us using the business connection. Whether to fully disconnect the bot from the current account. The bot to connect or disconnect Configuration for the business connection List all currently connected business bots » See Bots may invoke this method to re-fetch the associated with a specific business connection_id, see here » for more info on connected business bots.
This is needed for example for freshly logged in bots that are receiving some , etc. updates because some users have already connected to the bot before it could login.
In this case, the bot is receiving messages from the business connection, but it hasn't cached the associated with info about the connection (can it reply to messages? etc.) yet, and cannot receive the old ones because they were sent when the bot wasn't logged into the session yet.
This method can be used to fetch info about a not-yet-cached business connection, and should not be invoked if the info is already cached or to fetch changes, as eventual changes will automatically be sent as new updates to the bot using the usual update delivery methods ». See [bots: ✓] Possible codes: 400 (details) Business connection ID ». Set or remove the Telegram Business introduction ». See Telegram Business introduction, to remove it call the method without setting this flag. Pause or unpause a specific chat, temporarily disconnecting it from all business bots ». See Possible codes: 400 (details) The chat to pause Whether to pause or unpause the chat Permanently disconnect a specific chat from all business bots » (equivalent to specifying it in recipients.exclude_users during initial configuration with Account_UpdateConnectedBot); to reconnect of a chat disconnected using this method the user must reconnect the entire bot by invoking Account_UpdateConnectedBot. See Possible codes: 400 (details) The chat to disconnect Update our birthday, see here » for more info. See Possible codes: 400 (details) Birthday. Create a business chat deep link ». See Possible codes: 400,403 (details) Info about the link to create. Edit a created business chat deep link ». See Possible codes: 400,403 (details) Slug of the link, obtained as specified here ». New link information. Delete a business chat deep link ». See Possible codes: 400 (details) Slug of the link, obtained as specified here ». List all created business chat deep links ». See Resolve a business chat deep link ». See Possible codes: 400 (details) Slug of the link, obtained as specified here ». Associate (or remove) a personal channel », that will be listed on our personal profile page ». See The channel, pass to remove it. Disable or re-enable Telegram ads for the current Premium account. See Enable or disable ads. Get the current reaction notification settings ». See Change the reaction notification settings ». See New reaction notification settings. Returns basic user info according to their identifiers. See [bots: ✓] Possible codes: 400 (details) List of user identifiers Returns extended user info by ID. See [bots: ✓] Possible codes: 400 (details) User ID Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). See [bots: ✓] Possible codes: 400,403 (details) The user Errors Check whether we can write to the specified user (this method can only be called by non-Premium users), see here » for more info on the full flow. See Users to fetch info about. Get the telegram IDs of all contacts.
Returns an array of Telegram user IDs for all contacts (0 if a contact does not have an associated Telegram account or have hidden their account using privacy settings). See Hash used for caching, for more info click here Use this method to obtain the online statuses of all contacts with an accessible Telegram account. See Returns the current user's contact list. See Hash used for caching, for more info click here.
Note that the hash is computed using the usual algorithm, passing to the algorithm first the previously returned .saved_count field, then max 100000 sorted user IDs from the contact list, including the ID of the currently logged in user if it is saved as a contact.
Example: tdlib implementation. a null value means contacts.contactsNotModified Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. See List of contacts to import Deletes several contacts from the list. See User ID list Delete contacts by phone number See Phone numbers Adds a peer to a blocklist, see here » for more info. See Possible codes: 400 (details) Whether the peer should be added to the story blocklist; if not set, the peer will be added to the main blocklist, see here » for more info. Peer Deletes a peer from a blocklist, see here » for more info. See Possible codes: 400 (details) Whether the peer should be removed from the story blocklist; if not set, the peer will be removed from the main blocklist, see here » for more info. Peer Returns the list of blocked users. See Whether to fetch the story blocklist; if not set, will fetch the main blocklist. See here » for differences between the two. The number of list elements to be skipped The number of list elements to be returned Returns users found by username substring. See Possible codes: 400 (details) Target substring Maximum number of users to be returned Resolve a @username to get peer info See [bots: ✓] Possible codes: 400 (details) @username to resolve Get most used peers See Possible codes: 400 (details) Users we've chatted most frequently with Most used bots Most used inline bots Most frequently called users Users to which the users often forwards messages to Chats to which the users often forwards messages to Often-opened groups and supergroups Most frequently visited channels Most frequently used Main Mini Bot Apps. Offset for pagination Maximum number of results to return, see pagination Hash used for caching, for more info click here a null value means contacts.topPeersNotModified Reset rating of top peer See Possible codes: 400 (details) Top peer category Peer whose rating should be reset Removes all contacts without an associated Telegram account. See Get all contacts, requires a takeout session, see here » for more info. See Possible codes: 400,403 (details) Enable/disable top peers See Enable/disable Add an existing telegram user as contact. See Possible codes: 400 (details) Allow the other user to see our phone number? Telegram ID of the other user First name Last name User's phone number, may be omitted to simply add the user to the contact list, without a phone number. If the add contact action bar is active, add that user as contact See Possible codes: 400 (details) The user to add as contact Get users and geochats near you, see here » for more info. See Possible codes: 400,406 (details) While the geolocation of the current user is public, clients should update it in the background every half-an-hour or so, while setting this flag.
Do this only if the new location is more than 1 KM away from the previous one, or if the previous location is unknown. Geolocation If set, the geolocation of the current user will be public for the specified number of seconds; pass 0x7fffffff to disable expiry, 0 to make the current geolocation private; if the flag isn't set, no changes will be applied. Stop getting notifications about discussion replies of a certain user in @replies See Possible codes: 400 (details) Whether to delete the specified message as well Whether to delete all @replies messages from this user as well Whether to also report this user for spam ID of the message in the @replies chat Resolve a phone number to get user info, if their privacy settings allow it. See Possible codes: 400 (details) Phone number in international format, possibly obtained from a phone number deep link. Generates a temporary profile link for the currently logged-in user. See Obtain user info from a temporary profile link. See Possible codes: 400 (details) The token extracted from the temporary profile link. Edit the close friends list, see here » for more info. See Full list of user IDs of close friends, see here for more info. Replace the contents of an entire blocklist, see here for more info ». See Whether to edit the story blocklist; if not set, will edit the main blocklist. See here » for differences between the two. Full content of the blocklist. Maximum number of results to return, see pagination Fetch all users with birthdays that fall within +1/-1 days, relative to the current day: this method should be invoked by clients every 6-8 hours, and if the result is non-empty, it should be used to appropriately update locally cached birthday information in .birthday. See ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Returns the list of messages by their IDs. See [bots: ✓] Message ID list Returns the current user dialog list. See Possible codes: 400,403 (details) Exclude pinned dialogs Peer folder ID, for more info click here Offsets for pagination, for more info click here Offsets for pagination, for more info click here (top_message ID used for pagination) Offset peer for pagination Number of list elements to be returned Hash used for caching, for more info click here Returns the conversation history with one interlocutor / within a chat See Possible codes: 400,406 (details) Target peer Only return messages starting from the specified message ID Only return messages sent before the specified date Number of list elements to be skipped, negative values are also accepted. Number of results to return If a positive value was transferred, the method will return only messages with IDs less than max_id If a positive value was transferred, the method will return only messages with IDs more than min_id Result hash Search for messages. See Possible codes: 400,403 (details) User or chat, histories with which are searched, or to search in all private chats and normal groups (not channels) ». Use Messages_SearchGlobal to search globally in all chats, groups, supergroups and channels. Text search request Only return messages sent by the specified user ID Search within the saved message dialog » with this ID. You may search for saved messages tagged » with one or more reactions using this flag. Thread ID Filter to return only specified message types If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned Only return messages starting from the specified message ID Additional offset Number of results to return Maximum message ID to return Minimum message ID to return Hash Marks message history as read. See Possible codes: 400 (details) Target user or group If a positive value is passed, only messages with identifiers less or equal than the given one will be read Deletes communication history. See Possible codes: 400 (details) Just clear history for the current user, without actually removing messages for every chat user Whether to delete the message history for all chat participants User or chat, communication history of which will be deleted Maximum ID of message to delete Delete all messages newer than this UNIX timestamp Delete all messages older than this UNIX timestamp ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Deletes messages by their identifiers. See [bots: ✓] Possible codes: 400,403 (details) Whether to delete messages for all participants of the chat Message ID list ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Confirms receipt of messages by a client, cancels PUSH-notification sending. See Maximum message ID available in a client. Sends a current user typing event (see for all event types) to a conversation partner or group. See [bots: ✓] Possible codes: 400,403,406 (details) Target user or group Topic ID Type of action Sends a message to a chat See [bots: ✓] Possible codes: 400,403,406,420,500 (details) Set this flag to disable generation of the webpage preview Send this message silently (no notifications for the receivers) Send this message as background message Clear the draft field Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled Whether to move used stickersets to top, see here for more info on this flag » If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. The destination where the message will be sent If set, indicates that the message should be sent in reply to the specified message or story.
Also used to quote other messages. The message Unique client message ID required to prevent message resending You can use Reply markup for sending bot buttons Message entities for sending styled text Scheduled message date for scheduled messages Send this message as the specified peer Add the message to the specified quick reply shortcut », instead. Specifies a message effect » to use for the message. Send a media See [bots: ✓] Possible codes: 400,403,406,420,500 (details) Send message silently (no notification should be triggered) Send message in background Clear the draft Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled Whether to move used stickersets to top, see here for more info on this flag » If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. Destination If set, indicates that the message should be sent in reply to the specified message or story. Attached media Caption Random ID to avoid resending the same message You can use Reply markup for bot keyboards Message entities for styled text Scheduled message date for scheduled messages Send this message as the specified peer Add the message to the specified quick reply shortcut », instead. Specifies a message effect » to use for the message. Forwards messages by their IDs. See [bots: ✓] Possible codes: 400,403,406,420,500 (details) Whether to send messages silently (no notification will be triggered on the destination clients) Whether to send the message in background When forwarding games, whether to include your score in the game Whether to forward messages without quoting the original author Whether to strip captions from media Only for bots, disallows further re-forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. Source of messages IDs of messages Random ID to prevent resending of messages You can use Destination peer Destination forum topic Scheduled message date for scheduled messages Forward the messages as the specified peer Add the messages to the specified quick reply shortcut », instead. Report a new incoming chat for spam, if the of the chat allow us to do that See Possible codes: 400 (details) Peer to report Get peer settings See Possible codes: 400 (details) The peer Report a message in a chat for violation of telegram's Terms of Service See Possible codes: 400 (details) Peer IDs of messages to report Menu option, intially empty Comment for report moderation ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Returns chat basic info on their IDs. See [bots: ✓] Possible codes: 400 (details) List of chat IDs ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Get full info about a basic group. See [bots: ✓] Possible codes: 400 (details) Basic group ID. ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Changes chat name and sends a service message on it. See [bots: ✓] Possible codes: 400 (details) Chat ID New chat name, different from the old one ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Changes chat photo and sends a service message on it See [bots: ✓] Possible codes: 400 (details) Chat ID Photo to be set ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Adds a user to a chat and sends a service message on it. See Possible codes: 400,403 (details) Chat ID User ID to be added Number of last messages to be forwarded ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Deletes a user from a chat and sends a service message on it. See [bots: ✓] Possible codes: 400 (details) Remove the entire chat history of the specified user in this chat. Chat ID User ID to be deleted Creates a new chat. See Possible codes: 400,406,500 (details) List of user IDs to be invited Chat name Time-to-live of all messages that will be sent in the chat: once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. You can use Messages_SetDefaultHistoryTTL to edit this value later. Returns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length. See Possible codes: 400 (details) Value of the version parameter from , available at the client Length of the required random sequence Sends a request to start a secret chat to the user. See Possible codes: 400 (details) User ID Unique client request ID required to prevent resending. This also doubles as the chat ID. A = g ^ a mod p, see Wikipedia Confirms creation of a secret chat See Possible codes: 400 (details) Secret chat ID B = g ^ b mod p, see Wikipedia 64-bit fingerprint of the received key Cancels a request for creation and/or delete info on secret chat. See Possible codes: 400 (details) Whether to delete the entire chat history for the other user as well Secret chat ID Send typing event by the current user to a secret chat. See Possible codes: 400 (details) Secret chat ID Typing.
Possible values:
, if the user started typing and more than 5 seconds have passed since the last request
, if the user stopped typing Marks message history within a secret chat as read. See Possible codes: 400 (details) Secret chat ID Maximum date value for received messages in history Sends a text message to a secret chat. See Possible codes: 400,403,500 (details) Send encrypted message without a notification Secret chat ID Unique client message ID, necessary to avoid message resending You can use TL-serialization of type, encrypted with a key that was created during chat initialization Sends a message with a file attachment to a secret chat See Possible codes: 400 (details) Whether to send the file without triggering a notification Secret chat ID Unique client message ID necessary to prevent message resending You can use TL-serialization of type, encrypted with a key generated during chat initialization File attachment for the secret chat Sends a service message to a secret chat. See Possible codes: 400,403,500 (details) Secret chat ID Unique client message ID required to prevent message resending You can use TL-serialization of type, encrypted with a key generated during chat initialization Confirms receipt of messages in a secret chat by client, cancels push notifications.
The method returns a list of random_ids of messages for which push notifications were cancelled. See Possible codes: 400,500 (details) Maximum qts value available at the client Report a secret chat for spam See Possible codes: 400 (details) The secret chat to report ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Notifies the sender about the recipient having listened a voice message or watched a video. See Message ID list Get stickers by emoji See Possible codes: 400 (details) The emoji Hash used for caching, for more info click here. a null value means messages.stickersNotModified Get all installed stickers See Hash used for caching, for more info click here. a null value means messages.allStickersNotModified Get preview of webpage See Possible codes: 400 (details) Message from which to extract the preview Message entities for styled text a null value means messageMediaEmpty Export an invite link for a chat See [bots: ✓] Possible codes: 400,403 (details) Legacy flag, reproducing legacy behavior of this method: if set, revokes all previous links before creating a new one. Kept for bot API BC, should not be used by modern clients. Whether admin confirmation is required before admitting each separate user into the chat Chat Expiration date Maximum number of users that can join using this link Description of the invite link, visible only to administrators For Telegram Star subscriptions », contains the pricing of the subscription the user must activate to join the private channel. Check the validity of a chat invite link and get basic info about it See Possible codes: 400,406 (details) Invite hash from chat invite deep link ». Import a chat invite and join a private chat/supergroup/channel See Possible codes: 400,406 (details) hash from a chat invite deep link Get info about a stickerset See [bots: ✓] Possible codes: 400,406 (details) Stickerset Hash used for caching, for more info click here a null value means messages.stickerSetNotModified Install a stickerset See Possible codes: 406 (details) Stickerset to install Whether to archive stickerset Uninstall a stickerset See Possible codes: 406 (details) The stickerset to uninstall Start a conversation with a bot using a deep linking parameter See Possible codes: 400,403,500 (details) The bot The chat where to start the bot, can be the bot's private chat or a group Random ID to avoid resending the same message You can use Deep linking parameter Get and increase the view counter of a message sent or forwarded from a channel See Possible codes: 400,406 (details) Peer where the message was found ID of message Whether to mark the message as viewed and increment the view counter ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Make a user admin in a basic group. See Possible codes: 400 (details) The ID of the group The user to make admin Whether to make them admin ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Turn a basic group into a supergroup See Possible codes: 400,403,500 (details) Basic group to migrate Search for messages and peers globally See Possible codes: 400 (details) If set, only returns results from channels (used in the global channel search tab »). Peer folder ID, for more info click here Query Global search filter If a positive value was specified, the method will return only messages with date bigger than min_date If a positive value was transferred, the method will return only messages with date smaller than max_date Initially 0, then set to the next_rate parameter of messages.messagesSlice Offsets for pagination, for more info click here Offsets for pagination, for more info click here Offsets for pagination, for more info click here Reorder installed stickersets See Reorder mask stickersets Reorder custom emoji stickersets New stickerset order by stickerset IDs Get a document by its SHA256 hash, mainly used for gifs See [bots: ✓] Possible codes: 400 (details) SHA256 of file Size of the file in bytes Mime type Get saved GIFs. See Hash used for caching, for more info click here. a null value means messages.savedGifsNotModified Add GIF to saved gifs list See Possible codes: 400 (details) GIF to save Whether to remove GIF from saved gifs list Query an inline bot See Possible codes: 400,406,-503 (details) The bot to query The currently opened chat The geolocation, if requested The query The offset within the results, will be passed directly as-is to the bot. Answer an inline query, for bots only See [bots: ✓] Possible codes: 400,403 (details) Set this flag if the results are composed of media files Set this flag if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query Unique identifier for the answered query Vector of results for the inline query The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. If passed, clients will display a button on top of the remaining inline result list with the specified text, that switches the user to a private chat with the bot and sends the bot a start message with a certain parameter. If passed, clients will display a button on top of the remaining inline result list with the specified text, that switches the user to the specified inline mode mini app. Send a result obtained using Messages_GetInlineBotResults. See Possible codes: 400,403,420,500 (details) Whether to send the message silently (no notification will be triggered on the other client) Whether to send the message in background Whether to clear the draft Whether to hide the via @botname in the resulting message (only for bot usernames encountered in the ) Destination If set, indicates that the message should be sent in reply to the specified message or story. Random ID to avoid resending the same query You can use Query ID from Messages_GetInlineBotResults Result ID from Messages_GetInlineBotResults Scheduled message date for scheduled messages Send this message as the specified peer Add the message to the specified quick reply shortcut », instead. Find out if a media message's caption can be edited See Possible codes: 400,403 (details) Peer where the media was sent ID of message Edit message See [bots: ✓] Possible codes: 400,403,406,500 (details) Disable webpage preview If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Where was the message sent ID of the message to edit New message New attached media Reply markup for inline keyboards Message entities for styled text Scheduled message date for scheduled messages If specified, edits a quick reply shortcut message, instead ». Edit an inline bot message See [bots: ✓] Possible codes: 400 (details) Disable webpage preview If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Sent inline message ID Message Media Reply markup for inline keyboards Message entities for styled text Press an inline callback button and get a callback answer from the bot See Possible codes: 400,-503 (details) Whether this is a "play game" button Where was the inline keyboard sent ID of the Message with the inline keyboard Callback data For buttons requiring you to verify your identity with your 2FA password, the SRP payload generated using SRP. Set the callback answer to a user button press (bots only) See [bots: ✓] Possible codes: 400 (details) Whether to show the message as a popup instead of a toast notification Query ID Popup to show URL to open Cache validity Get dialog info of specified peers See Possible codes: 400,406 (details) Peers Save a message draft associated to a chat. See Possible codes: 400 (details) Disable generation of the webpage preview If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. If set, indicates that the message should be sent in reply to the specified message or story. Destination of the message that should be sent The draft Message entities for styled text Attached media Specifies a message effect » to use for the message. Return all message drafts.
Returns all the latest updates related to all chats with drafts. See Get featured stickers See Hash used for caching, for more info click here. Mark new featured stickers as read See IDs of stickersets to mark as read Get recent stickers See Get stickers recently attached to photo or video files Hash used for caching, for more info click here. a null value means messages.recentStickersNotModified Add/remove sticker from recent stickers list See Possible codes: 400 (details) Whether to add/remove stickers recently attached to photo or video files Sticker Whether to save or unsave the sticker Clear recent stickers See Set this flag to clear the list of stickers recently attached to photo or video files Get all archived stickers See Get mask stickers Get custom emoji stickers Offsets for pagination, for more info click here Maximum number of results to return, see pagination Get installed mask stickers See Hash used for caching, for more info click here. a null value means messages.allStickersNotModified Get stickers attached to a photo or video See Possible codes: 400 (details) Stickered media Use this method to set the score of the specified user in a game sent as a normal message (bots only). See [bots: ✓] Possible codes: 400 (details) Set this flag if the game message should be automatically edited to include the current scoreboard Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters Unique identifier of target chat Identifier of the sent message User identifier New score Use this method to set the score of the specified user in a game sent as an inline message (bots only). See [bots: ✓] Possible codes: 400 (details) Set this flag if the game message should be automatically edited to include the current scoreboard Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters ID of the inline message User identifier New score Get highscores of a game See [bots: ✓] Possible codes: 400 (details) Where was the game sent ID of message with game media attachment Get high scores made by a certain user Get highscores of a game sent using an inline bot See [bots: ✓] Possible codes: 400 (details) ID of inline message Get high scores of a certain user Get chats in common with a user See Possible codes: 400 (details) User ID Maximum ID of chat to return (see pagination) Maximum number of results to return, see pagination Get instant view page See Possible codes: 400 (details) URL of IV page to fetch Hash used for caching, for more info click here.
Note: the usual hash generation algorithm cannot be used in this case, please re-use the .hash field returned by a previous call to the method, or pass 0 if this is the first call or if the previous call did not return a . Pin/unpin a dialog See Possible codes: 400 (details) Whether to pin or unpin the dialog The dialog to pin Reorder pinned dialogs See Possible codes: 400 (details) If set, dialogs pinned server-side but not present in the order field will be unpinned. Peer folder ID, for more info click here New dialog order Get pinned dialogs See Possible codes: 400 (details) Peer folder ID, for more info click here If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an update. Use this method to reply to shipping queries. See [bots: ✓] Possible codes: 400 (details) Unique identifier for the query to be answered Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable"). Telegram will display this message to the user. A vector of available shipping options. Once the user has confirmed their payment and shipping details, the bot receives an update.
Use this method to respond to such pre-checkout queries.
Note: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. See [bots: ✓] Possible codes: 400 (details) Set this flag if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order, otherwise do not set it, and set the error field, instead Unique identifier for the query to be answered Required if the success isn't set. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. Upload a file and associate it to a chat (without actually sending it to the chat) See [bots: ✓] Possible codes: 400,403 (details) Whether the media will be used only in the specified business connection », and not directly by the bot. The chat, can be for bots and for users. File uploaded in chunks as described in files » a null value means messageMediaEmpty Notify the other user in a private chat that a screenshot of the chat was taken See Possible codes: 400 (details) Other user Indicates the message that was screenshotted (the specified message ID can also be 0 to avoid indicating any specific message). Random ID to avoid message resending You can use Get faved stickers See Hash used for caching, for more info click here. a null value means messages.favedStickersNotModified Mark or unmark a sticker as favorite See Possible codes: 400 (details) Sticker in question Whether to add or remove a sticker from favorites Get unread messages where we were mentioned See Possible codes: 400 (details) Peer where to look for mentions If set, considers only messages within the specified forum topic Offsets for pagination, for more info click here Offsets for pagination, for more info click here Maximum number of results to return, see pagination Maximum message ID to return, see pagination Minimum message ID to return, see pagination Mark mentions as read See Possible codes: 400 (details) Dialog Mark as read only mentions within the specified forum topic Get live location history of a certain user See User Maximum number of results to return, see pagination Hash used for caching, for more info click here Send an album or grouped media See [bots: ✓] Possible codes: 400,403,420,500 (details) Whether to send the album silently (no notification triggered) Send in background? Whether to clear drafts Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled Whether to move used stickersets to top, see here for more info on this flag » If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. The destination chat If set, indicates that the message should be sent in reply to the specified message or story. The medias to send: note that they must be separately uploaded using Messages_UploadMedia first, using raw inputMediaUploaded* constructors is not supported. Scheduled message date for scheduled messages Send this message as the specified peer Add the message to the specified quick reply shortcut », instead. Specifies a message effect » to use for the message. Upload encrypted file and associate it to a secret chat See Possible codes: 400 (details) The secret chat to associate the file to The file a null value means encryptedFileEmpty Search for stickersets See Exclude featured stickersets from results Query string Hash used for caching, for more info click here. a null value means messages.foundStickerSetsNotModified Get message ranges for saving the user's chat history See Manually mark dialog as unread See Possible codes: 400 (details) Mark as unread/read Dialog Get dialogs manually marked as unread See Clear all drafts. See Pin a message See [bots: ✓] Possible codes: 400,403 (details) Pin the message silently, without triggering a notification Whether the message should unpinned or pinned Whether the message should only be pinned on the local side of a one-to-one chat The peer where to pin the message The message to pin or unpin Vote in a See Possible codes: 400 (details) The chat where the poll was sent The message ID of the poll The options that were chosen Get poll results See Possible codes: 400 (details) Peer where the poll was found Message ID of poll message Get count of online users in a chat See Possible codes: 400 (details) The chat Edit the description of a group/supergroup/channel. See [bots: ✓] Possible codes: 400,403 (details) The group/supergroup/channel. The new description Edit the default banned rights of a channel/supergroup/group. See [bots: ✓] Possible codes: 400,403 (details) The peer The new global rights Get localized emoji keywords ». See Language code Get changed emoji keywords ». See Language code Previous stored emoji keyword list version Obtain a list of related languages that must be used when fetching emoji keyword lists ». See The user's language codes Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji keywords ». The URL will be valid for 30 seconds after generation. See Language code for which the emoji keywords will be suggested Get the number of results that would be found by a Messages_Search call with the same parameters See Possible codes: 400 (details) Peer where to search Search within the saved message dialog » with this ID. If set, consider only messages within the specified forum topic Search filters Get more info about a Seamless Telegram Login authorization request, for more info click here » See Peer where the message is located The message The ID of the button with the authorization request URL used for link URL authorization, click here for more info » a null value means urlAuthResultDefault Use this to accept a Seamless Telegram Login authorization request, for more info click here » See Set this flag to allow the bot to send messages to you (if requested) The location of the message Message ID of the message with the login button ID of the login button URL used for link URL authorization, click here for more info » a null value means urlAuthResultDefault Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the action bar ». See Possible codes: 400 (details) Peer Get scheduled messages See Possible codes: 400 (details) Peer Hash used for caching, for more info click here.
To generate the hash, populate the ids array with the id, date and edit_date (in this order) of the previously returned messages (in order, i.e. ids = [id1, date1, edit_date1, id2, date2, edit_date2, ...]). Get scheduled messages See Possible codes: 400 (details) Peer IDs of scheduled messages Send scheduled messages right away See Possible codes: 400,500 (details) Peer Scheduled message IDs Delete scheduled messages See Possible codes: 400,403 (details) Peer Scheduled message IDs Get poll results for non-anonymous polls See Possible codes: 400,403 (details) Chat where the poll was sent Message ID Get only results for the specified poll option Offset for results, taken from the next_offset field of , initially an empty string.
Note: if no more results are available, the method call will return an empty next_offset; thus, avoid providing the next_offset returned in if it is empty, to avoid an infinite loop. Number of results to return Apply changes to multiple stickersets See Uninstall the specified stickersets Archive the specified stickersets Unarchive the specified stickersets Stickersets to act upon Get folders See Get suggested folders See Update folder See Possible codes: 400 (details) Folder ID Folder info Reorder folders See New folder order Method for fetching previously featured stickers See Offset Maximum number of results to return, see pagination Hash used for caching, for more info click here. Get messages in a reply thread See Possible codes: 400 (details) Peer Message ID Offsets for pagination, for more info click here Offsets for pagination, for more info click here Offsets for pagination, for more info click here Maximum number of results to return, see pagination If a positive value was transferred, the method will return only messages with ID smaller than max_id If a positive value was transferred, the method will return only messages with ID bigger than min_id Hash used for caching, for more info click here Get discussion message from the associated discussion group of a channel to show it on top of the comment section, without actually joining the group See Possible codes: 400 (details) Channel ID Message ID Mark a thread as read See Possible codes: 400 (details) Group ID ID of message that started the thread ID up to which thread messages were read Unpin all pinned messages See [bots: ✓] Possible codes: 400 (details) Chat where to unpin Forum topic where to unpin ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Delete a chat See Possible codes: 400 (details) Chat ID Delete the entire phone call history. See Whether to remove phone call history for participants as well Obtains information about a chat export file, generated by a foreign chat app, click here for more info about imported chats ». See Possible codes: 400 (details) Beginning of the message file; up to 100 lines. Import chat history from a foreign chat app into a specific Telegram chat, click here for more info about imported chats ». See Possible codes: 400,406 (details) The Telegram chat where the history should be imported. File with messages to import. Number of media files associated with the chat that will be uploaded using Messages_UploadImportedMedia. Upload a media file associated with an imported chat, click here for more info ». See Possible codes: 400 (details) The Telegram chat where the media will be imported Identifier of a history import session, returned by Messages_InitHistoryImport File name Media metadata a null value means messageMediaEmpty Complete the history import process, importing all messages into the chat.
To be called only after initializing the import with Messages_InitHistoryImport and uploading all files using Messages_UploadImportedMedia. See Possible codes: 400 (details) The Telegram chat where the messages should be imported, click here for more info » Identifier of a history import session, returned by Messages_InitHistoryImport. Get info about the chat invites of a specific chat See Possible codes: 400,403 (details) Whether to fetch revoked chat invites Chat Whether to only fetch chat invites from this admin Offsets for pagination, for more info click here Offsets for pagination, for more info click here Maximum number of results to return, see pagination Get info about a chat invite See Possible codes: 400,403 (details) Chat Invite link Edit an exported chat invite See [bots: ✓] Possible codes: 400,403 (details) Whether to revoke the chat invite Chat Invite link New expiration date Maximum number of users that can join using this link Whether admin confirmation is required before admitting each separate user into the chat Description of the invite link, visible only to administrators Delete all revoked chat invites See Possible codes: 400 (details) Chat ID of the admin that originally generated the revoked chat invites Delete a chat invite See Possible codes: 400 (details) Peer Invite link Get info about chat invites generated by admins. See Possible codes: 400,403 (details) Chat Get info about the users that joined the chat using a specific chat invite See Possible codes: 400,403 (details) If set, only returns info about users with pending join requests » Set this flag if the link is a Telegram Star subscription link » and only members with already expired subscription must be returned. Chat Invite link Search for a user in the pending join requests » list: only available when the requested flag is set, cannot be used together with a specific link. Offsets for pagination, for more info click here User ID for pagination: if set, offset_date must also be set. Maximum number of results to return, see pagination Set maximum Time-To-Live of all messages in the specified chat See Possible codes: 400 (details) The dialog Automatically delete all messages sent in the chat after this many seconds Check whether chat history exported from another chat app can be imported into a specific Telegram chat, click here for more info ». See Possible codes: 400 (details) The chat where we want to import history ». Change the chat theme of a certain chat See Possible codes: 400 (details) Private chat where to change theme Emoji, identifying a specific chat theme; a list of chat themes can be fetched using Account_GetChatThemes Get which users read a specific message: only available for groups and supergroups with less than chat_read_mark_size_threshold members, read receipts will be stored for chat_read_mark_expire_period seconds after the message was sent, see client configuration for more info ». See Possible codes: 400 (details) Dialog Message ID Returns information about the next messages of the specified type in the chat split by days. See Possible codes: 400 (details) Peer where to search Search within the saved message dialog » with this ID. Message filter, , filters are not supported by this method. Offsets for pagination, for more info click here Offsets for pagination, for more info click here Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. See Possible codes: 400 (details) Peer where to search Search within the saved message dialog » with this ID. Message filter, , filters are not supported by this method. Offsets for pagination, for more info click here Maximum number of results to return, see pagination Dismiss or approve a chat join request related to a specific chat or channel. See [bots: ✓] Possible codes: 400,403 (details) Whether to dismiss or approve the chat join request » The chat or channel The user whose join request » should be dismissed or approved Dismiss or approve all join requests related to a specific chat or channel. See Possible codes: 400,403 (details) Whether to dismiss or approve all chat join requests » The chat or channel Only dismiss or approve join requests » initiated using this invite link Enable or disable content protection on a channel or chat See Possible codes: 400 (details) The chat or channel Enable or disable content protection Change the default peer that should be used when sending messages, reactions, poll votes to a specific group See Possible codes: 400 (details) Group The default peer that should be used when sending messages to the group React to message. See Possible codes: 400,403 (details) Whether a bigger and longer reaction should be shown Whether to add this reaction to the recent reactions list ». Peer Message ID to react to A list of reactions Get message reactions » See Possible codes: 400 (details) Peer Message IDs Get message reaction list, along with the sender of each reaction. See Possible codes: 400,403 (details) Peer Message ID Get only reactions of this type Offset for pagination (taken from the next_offset field of the returned ); empty in the first request. Maximum number of results to return, see pagination Change the set of message reactions » that can be used in a certain group, supergroup or channel See Possible codes: 400 (details) Group where to apply changes Allowed reaction emojis This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max); this field and the other info set by the method will then be available to users in and .
If this flag is not set, the previously configured reactions_limit will not be altered. If this flag is set and a is passed, the method will enable or disable paid message reactions ». If this flag is not set, the previously stored setting will not be changed. Obtain available message reactions » See Hash used for caching, for more info click here. a null value means messages.availableReactionsNotModified Change default emoji reaction to use in the quick reaction menu: the value is synced across devices and can be fetched using Help_GetConfig. See Possible codes: 400 (details) New emoji reaction Translate a given text. See Possible codes: 400 (details) If the text is a chat message, the peer ID A list of message IDs to translate A list of styled messages to translate Two-letter ISO 639-1 language code of the language to which the message is translated Get unread reactions to messages you sent See Possible codes: 400 (details) Peer If set, considers only reactions to messages within the specified forum topic Offsets for pagination, for more info click here Offsets for pagination, for more info click here Maximum number of results to return, see pagination Only return reactions for messages up until this message ID Only return reactions for messages starting from this message ID Mark message reactions » as read See Possible codes: 400 (details) Peer Mark as read only reactions to messages within the specified forum topic View and search recently sent media.
This method does not support pagination. See Possible codes: 400 (details) Optional search query Message filter Maximum number of results to return (max 100). Returns installed attachment menu bot mini apps » See Hash used for caching, for more info click here. a null value means attachMenuBotsNotModified Returns attachment menu entry for a bot mini app that can be launched from the attachment menu » See Possible codes: 400 (details) Bot ID Enable or disable web bot attachment menu » See Possible codes: 400 (details) Whether the user authorizes the bot to write messages to them, if requested by .request_write_access Bot ID Toggle Open a bot mini app, sending over user information after user confirmation. See Possible codes: 400,403 (details) Whether the webview was opened by clicking on the bot's menu button ». Whether the inline message that will be sent by the bot on behalf of the user once the web app interaction is Messages_SendWebViewResultMessage should be sent silently (no notifications for the receivers). If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the attachment menu deep link is equal to compact. Dialog where the web app is being opened, and where the resulting message will be sent (see the docs for more info »). Bot that owns the web app Web app URL If the web app was opened from the attachment menu using a attachment menu deep link, start_param should contain the data from the startattach parameter. Theme parameters » Short name of the application; 0-64 English letters, digits, and underscores If set, indicates that the inline message that will be sent by the bot on behalf of the user once the web app interaction is Messages_SendWebViewResultMessage should be sent in reply to the specified message or story. Open the web app as the specified peer, sending the resulting the message as the specified peer. Indicate to the server (from the user side) that the user is still using a web app. See Possible codes: 400 (details) Whether the inline message that will be sent by the bot on behalf of the user once the web app interaction is Messages_SendWebViewResultMessage should be sent silently (no notifications for the receivers). Dialog where the web app was opened. Bot that owns the web app Web app interaction ID obtained from Messages_RequestWebView If set, indicates that the inline message that will be sent by the bot on behalf of the user once the web app interaction is Messages_SendWebViewResultMessage should be sent in reply to the specified message or story. Open the web app as the specified peer Open a bot mini app. See Possible codes: 400 (details) Whether the webapp was opened by clicking on the switch_webview button shown on top of the inline results list returned by Messages_GetInlineBotResults. Set this flag if opening the Mini App from the installed side menu entry ». Deprecated. Bot that owns the mini app Web app URL, if opening from a keyboard button or inline result Deprecated. Theme parameters » Short name of the application; 0-64 English letters, digits, and underscores ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Terminate webview interaction started with Messages_RequestWebView, sending the specified message to the chat on behalf of the user. See [bots: ✓] Possible codes: 400 (details) Webview interaction ID obtained from Messages_RequestWebView Message to send Used by the user to relay data from an opened reply keyboard bot mini app to the bot that owns it. See Possible codes: 400 (details) Bot that owns the web app Unique client message ID to prevent duplicate sending of the same event You can use Text of the that was pressed to open the web app. Data to relay to the bot, obtained from a web_app_data_send JS event. Transcribe voice message See Possible codes: 400,403 (details) Peer ID where the voice message was sent Voice message ID Rate transcribed voice message See Peer where the voice message was sent Message ID Transcription ID Whether the transcription was correct Fetch custom emoji stickers ». See [bots: ✓] Custom emoji IDs from a . Gets the list of currently installed custom emoji stickersets. See Hash used for caching, for more info click here. a null value means messages.allStickersNotModified Gets featured custom emoji stickersets. See Hash used for caching, for more info click here. Report a message reaction See Possible codes: 400 (details) Peer where the message was sent Message ID Peer that sent the reaction Got popular message reactions See Maximum number of results to return, see pagination Hash used for caching, for more info click here. a null value means messages.reactionsNotModified Get recently used message reactions See Maximum number of results to return, see pagination Hash used for caching, for more info click here. a null value means messages.reactionsNotModified Clear recently used message reactions See Fetch updated information about paid media, see here » for the full flow. See Peer with visible paid media messages. IDs of currently visible messages containing paid media. Changes the default value of the Time-To-Live setting, applied to all new chats. See Possible codes: 400 (details) The new default Time-To-Live of all messages sent in new chats. Gets the default value of the Time-To-Live setting, applied to all new chats. See Send one or more chosen peers, as requested by a button. See Possible codes: 400 (details) The bot that sent the button. ID of the message that contained the reply keyboard with the button. The button_id field from the . The chosen peers. Represents a list of emoji categories. See Hash used for caching, for more info click here. a null value means messages.emojiGroupsNotModified Represents a list of emoji categories, to be used when selecting custom emojis to set as custom emoji status. See Hash used for caching, for more info click here. a null value means messages.emojiGroupsNotModified Represents a list of emoji categories, to be used when selecting custom emojis to set as profile picture. See Hash used for caching, for more info click here. a null value means messages.emojiGroupsNotModified Look for custom emojis associated to a UTF8 emoji See Possible codes: 400 (details) The emoji Hash used for caching, for more info click here. a null value means emojiListNotModified Show or hide the real-time chat translation popup for a certain chat See Possible codes: 400 (details) Whether to disable or enable the real-time chat translation popup The peer Obtain information about a direct link Mini App See Possible codes: 400 (details) Bot app information obtained from a Direct Mini App deep link ». Hash used for caching, for more info click here Open a bot mini app from a direct Mini App deep link, sending over user information after user confirmation. See Possible codes: 400 (details) Set this flag if the bot is asking permission to send messages to the user as specified in the direct Mini App deep link docs, and the user agreed. If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the direct Mini App deep link is equal to compact. If the client has clicked on the link in a Telegram chat, pass the chat's peer information; otherwise pass the bot's peer information, instead. The app obtained by invoking Messages_GetBotApp as specified in the direct Mini App deep link docs. If the startapp query string parameter is present in the direct Mini App deep link, pass it to start_param. Theme parameters » Short name of the application; 0-64 English letters, digits, and underscores Set a custom wallpaper » in a specific private chat with another user. See Possible codes: 400 (details) Only for Premium users, sets the specified wallpaper for both users of the chat, without requiring confirmation from the other user. If we don't like the new wallpaper the other user of the chat has chosen for us using the for_both flag, we can re-set our previous wallpaper just on our side using this flag. The private chat where the wallpaper will be set The wallpaper », obtained as described in the wallpaper documentation »; must not be provided when installing a wallpaper obtained from a service message (id must be provided, instead). Wallpaper settings, obtained as described in the wallpaper documentation » or from .wallpaper.settings. If the wallpaper was obtained from a service message, must contain the ID of that message. Search for custom emoji stickersets » See Exclude featured stickersets from results Query string Hash used for caching, for more info click here. a null value means messages.foundStickerSetsNotModified Returns the current saved dialog list, see here » for more info. See Exclude pinned dialogs Offsets for pagination, for more info click here Offsets for pagination, for more info click here (top_message ID used for pagination) Offset peer for pagination Number of list elements to be returned Hash used for caching, for more info click here Returns saved messages » forwarded from a specific peer See Possible codes: 400 (details) Target peer Only return messages starting from the specified message ID Only return messages sent before the specified date Number of list elements to be skipped, negative values are also accepted. Number of results to return If a positive value was transferred, the method will return only messages with IDs less than max_id If a positive value was transferred, the method will return only messages with IDs more than min_id Result hash Deletes messages forwarded from a specific peer to saved messages ». See Possible codes: 400 (details) Peer, whose messages will be deleted from saved messages » Maximum ID of message to delete Delete all messages newer than this UNIX timestamp Delete all messages older than this UNIX timestamp Get pinned saved dialogs, see here » for more info. See Pin or unpin a saved message dialog ». See Possible codes: 400 (details) Whether to pin or unpin the dialog The dialog to pin Reorder pinned saved message dialogs ». See If set, dialogs pinned server-side but not present in the order field will be unpinned. New dialog order Fetch the full list of saved message tags created by the user. See If set, returns tags only used in the specified saved message dialog. Hash used for caching, for more info click here. a null value means messages.savedReactionTagsNotModified Update the description of a saved message tag ». See Possible codes: 400,403 (details) Reaction associated to the tag Tag description, max 12 UTF-8 characters; to remove the description call the method without setting this flag. Fetch a default recommended list of saved message tag reactions. See Hash used for caching, for more info click here. a null value means messages.reactionsNotModified Get the exact read date of one of our messages, sent to a private chat with another user. See Possible codes: 400,403 (details) The user to whom we sent the message. The message ID. Fetch basic info about all existing quick reply shortcuts. See Hash for pagination, generated as specified here » (not the usual algorithm used for hash generation.) a null value means messages.quickRepliesNotModified Reorder quick reply shortcuts. See Possible codes: 403 (details) IDs of all created quick reply shortcuts, in the desired order. Before offering the user the choice to add a message to a quick reply shortcut, to make sure that none of the limits specified here » were reached. See Possible codes: 403 (details) Shorcut name (not ID!). Rename a quick reply shortcut.
This will emit an update to other logged-in sessions. See Possible codes: 400,403 (details) Shortcut ID. New shortcut name. Completely delete a quick reply shortcut.
This will also emit an update to other logged-in sessions (and no updates, even if all the messages in the shortcuts are also deleted by this method). See Possible codes: 400 (details) Shortcut ID ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Fetch (a subset or all) messages in a quick reply shortcut ». See Possible codes: 400 (details) Quick reply shortcut ID. IDs of the messages to fetch, if empty fetches all of them. Hash used for caching, for more info click here Send a quick reply shortcut ». See Possible codes: 400,403 (details) The peer where to send the shortcut (users only, for now). The ID of the quick reply shortcut to send. Specify a subset of messages from the shortcut to send; if empty, defaults to all of them. Unique client IDs required to prevent message resending, one for each message we're sending, may be empty (but not recommended). You can use ⚠ This method is only for basic Chat. See Terminology in the README to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Delete one or more messages from a quick reply shortcut. This will also emit an update. See Possible codes: 400 (details) Shortcut ID. IDs of shortcut messages to delete. Enable or disable folder tags ». See Possible codes: 403 (details) Enable or disable folder tags. Fetch all stickersets » owned by the current user. See Offsets for pagination, for more info click here Maximum number of results to return, see pagination Represents a list of emoji categories, to be used when choosing a sticker. See Hash used for caching, for more info click here. a null value means messages.emojiGroupsNotModified Fetch the full list of usable animated message effects ». See Hash used for caching, for more info click here. a null value means messages.availableEffectsNotModified Edit/create a fact-check on a message. See Possible codes: 400,403 (details) Peer where the message was sent Message ID Fact-check (maximum UTF-8 length specified in appConfig.factcheck_length_limit). Delete a fact-check from a message. See Possible codes: 400,403 (details) Peer where the message was sent. Message ID Fetch one or more factchecks, see here » for the full flow. See Possible codes: 400 (details) Peer where the messages were sent. Messages that have associated s with the need_check flag set. Open a Main Mini App. See Possible codes: 400 (details) If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the Main Mini App link is equal to compact. Currently open chat, may be if no chat is currently open. Bot that owns the main mini app. Start parameter, if opening from a Main Mini App link ». Theme parameters » Short name of the application; 0-64 English letters, digits, and underscores Sends one or more paid Telegram Star reactions », transferring Telegram Stars » to a channel's balance. See [bots: ✓] The channel The message to react to The number of stars to send (each will increment the reaction counter by one). Unique client message ID required to prevent message resending You can use Each post with star reactions has a leaderboard with the top senders, but users can opt out of appearing there if they prefer more privacy.
If the user explicitly chose to make their paid reaction(s) private, pass to Messages_SendPaidReaction.private.
If the user explicitly chose to make their paid reaction(s) private, pass to Messages_SendPaidReaction.private.
If the user did not make any explicit choice about the privacy of their paid reaction(s) (i.e. when reacting by clicking on an existing star reaction on a message), do not populate the Messages_SendPaidReaction.private flag. Changes the privacy of already sent paid reactions on a specific message. See [bots: ✓] The channel The ID of the message to which we sent the paid reactions If true, makes the current anonymous in the top sender leaderboard for this message; otherwise, does the opposite. Fetches an update with the current default paid reaction privacy, see here » for more info. See [bots: ✓] Mark a specific sponsored message » as read See [bots: ✓] The channel/bot where the ad is located The ad's unique ID. Informs the server that the user has interacted with a sponsored message in one of the ways listed here ». See [bots: ✓] The user clicked on the media The user expanded the video to full screen, and then clicked on it. The channel/bot where the ad is located The ad's unique ID. Report a sponsored message », see here » for more info on the full flow. See [bots: ✓] The channel/bot where the ad is located The ad's unique ID. Chosen report option, initially an empty string, see here » for more info on the full flow. Get a list of sponsored messages for a peer, see here » for more info. See [bots: ✓] The currently open channel/bot. a null value means messages.sponsoredMessagesEmpty See See See Returns a current state of updates. See [bots: ✓] Get new updates. See [bots: ✓] Possible codes: 400,403,500 (details) PTS, see updates. PTS limit For fast updating: if provided and pts + pts_total_limit < remote pts, will be returned.
Simply tells the server to not return the difference if it is bigger than pts_total_limit
If the remote pts is too big (> ~4000000), this field will default to 1000000 date, see updates. QTS, see updates. QTS limit Returns the difference between the current state of updates of a certain channel and transmitted. See [bots: ✓] Possible codes: 400,403,406,500 (details) Set to true to skip some possibly unneeded updates and reduce server-side load The channel Messsage filter Persistent timestamp (see updates) How many updates to fetch, max 100000
Ordinary (non-bot) users are supposed to pass 10-100 Installs a previously uploaded photo as a profile photo. See [bots: ✓] Possible codes: 400 (details) If set, the chosen profile photo will be shown to users that can't display your main profile photo due to your privacy settings. Can contain info of a bot we own, to change the profile photo of that bot, instead of the current user. Input photo Updates current user profile photo. See [bots: ✓] Possible codes: 400 (details) If set, the chosen profile photo will be shown to users that can't display your main profile photo due to your privacy settings. Can contain info of a bot we own, to change the profile photo of that bot, instead of the current user. Profile photo Animated profile picture video Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if video or video_emoji_markup is set. Animated sticker profile picture, must contain either a or a . Deletes profile photos. The method returns a list of successfully deleted photo IDs. See Input photos to delete Returns the list of user photos. See [bots: ✓] Possible codes: 400 (details) User ID Number of list elements to be skipped If a positive value was transferred, the method will return only photos with IDs less than the set one. This parameter is often useful when refetching file references », as in conjuction with limit=1 and offset=-1 the object with the id specified in max_id can be fetched. Number of list elements to be returned Upload a custom profile picture for a contact, or suggest a new profile picture to a contact. See Possible codes: 400 (details) If set, will send a service message to user_id, suggesting them to use the specified profile picture; otherwise, will set a personal profile picture for the user (only visible to the current user). If set, removes a previously set personal profile picture (does not affect suggested profile pictures, to remove them simply deleted the service message with Messages_DeleteMessages). The contact Profile photo Animated profile picture video Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if video or video_emoji_markup is set. Animated sticker profile picture, must contain either a or a . Saves a part of file for further sending to one of the methods. See [bots: ✓] Possible codes: 400 (details) Random file identifier created by the client Numerical order of a part Binary data, content of a part Returns content of a whole file or its part. See [bots: ✓] Possible codes: 400,406,420 (details) Disable some checks on limit and offset values, useful for example to stream videos by keyframes Whether the current client supports CDN downloads File location Number of bytes to be skipped Number of bytes to be returned Saves a part of a large file (over 10 MB in size) to be later passed to one of the methods. See [bots: ✓] Possible codes: 400 (details) Random file id, created by the client Part sequence number Total number of parts Binary data, part contents Returns content of a web file, by proxying the request through telegram, see the webfile docs for more info. See Possible codes: 400 (details) The file to download Number of bytes to be skipped Number of bytes to be returned Download a CDN file. See Possible codes: 400 (details) File token Offset of chunk to download Length of chunk to download Request a reupload of a certain file to a CDN DC. See [bots: ✓] Possible codes: 400,500 (details) File token Request token Get SHA256 hashes for verifying downloaded CDN files See [bots: ✓] Possible codes: 400 (details) File Offset from which to start getting hashes Get SHA256 hashes for verifying downloaded files See [bots: ✓] Possible codes: 400 (details) File Offset from which to get file hashes Returns current configuration, including data center configuration. See [bots: ✓] Possible codes: 400,403 (details) Returns info on data center nearest to the user. See Returns information on update availability for the current application. See Source a null value means help.noAppUpdate Returns localized text of a text message with an invitation. See Returns the support user for the "ask a question" feature. See Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only See [bots: ✓] Possible codes: 400 (details) Number of pending updates Error message, if present Get configuration for CDN file downloads. See [bots: ✓] Get recently used t.me links. See Referrer Look for updates of telegram's terms of service See Accept the new terms of service See Possible codes: 400 (details) ID of terms of service Get info about an unsupported deep link, see here for more info ». See Path component of a tg: link a null value means help.deepLinkInfoEmpty Get app-specific configuration, see client configuration for more info on the result. See Hash used for caching, for more info click here. a null value means help.appConfigNotModified Saves logs of application on the server. See List of input events Get passport configuration See Hash used for caching, for more info click here. a null value means help.passportConfigNotModified Get localized name of the telegram support user See Possible codes: 403 (details) Can only be used by TSF members to obtain internal information. See Possible codes: 403 (details) User ID a null value means help.userInfoEmpty Internal use See Possible codes: 400,403 (details) User Message Message entities for styled text a null value means help.userInfoEmpty Get MTProxy/Public Service Announcement information See Hide MTProxy/Public Service Announcement information See Peer to hide Dismiss a suggestion, see here for more info ». See In the case of pending suggestions in channels, the channel ID. Suggestion, see here for more info ». Get name, ISO code, localized name and phone codes/patterns of all available countries See Language code of the current user Hash used for caching, for more info click here. a null value means help.countriesListNotModified Get Telegram Premium promotion information See Get the set of accent color palettes » that can be used for message accents. See Hash used for caching, for more info click here. a null value means help.peerColorsNotModified Get the set of accent color palettes » that can be used in profile page backgrounds. See Hash used for caching, for more info click here. a null value means help.peerColorsNotModified Returns timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours ». See Hash used for caching, for more info click here. a null value means help.timezonesListNotModified Mark channel/supergroup history as read See Possible codes: 400,406 (details) Channel/supergroup ID of message up to which messages should be marked as read Delete messages in a channel/supergroup See [bots: ✓] Possible codes: 400,403,406 (details) Channel/supergroup IDs of messages to delete Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup See Possible codes: 400 (details) Supergroup Participant whose messages should be reported IDs of spam messages Get channel/supergroup messages See [bots: ✓] Possible codes: 400,406 (details) Channel/supergroup IDs of messages to get Get the participants of a supergroup/channel See [bots: ✓] Possible codes: 400,403,406 (details) Channel Which participant types to fetch Offset Limit Hash a null value means channels.channelParticipantsNotModified Get info about a channel/supergroup participant See [bots: ✓] Possible codes: 400,403,406 (details) Channel/supergroup Participant to get info about Get info about channels/supergroups See [bots: ✓] Possible codes: 400,406 (details) IDs of channels/supergroups to get info about Get full info about a supergroup, gigagroup or channel See [bots: ✓] Possible codes: 400,403,406 (details) The channel, supergroup or gigagroup to get info about Create a supergroup/channel. See Possible codes: 400,406,500 (details) Whether to create a channel Whether to create a supergroup Whether the supergroup is being created to import messages from a foreign chat service using Messages_InitHistoryImport Whether to create a forum Channel title Channel description Geogroup location, see here » for more info on geogroups. Geogroup address, see here » for more info on geogroups. Time-to-live of all messages that will be sent in the supergroup: once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. You can use Messages_SetDefaultHistoryTTL to edit this value later. Modify the admin rights of a user in a supergroup/channel. See [bots: ✓] Possible codes: 400,403,406 (details) The supergroup/channel. The ID of the user whose admin rights should be modified The admin rights Indicates the role (rank) of the admin in the group: just an arbitrary string Edit the name of a channel/supergroup See [bots: ✓] Possible codes: 400,403 (details) Channel/supergroup New name Change the photo of a channel/supergroup See [bots: ✓] Possible codes: 400,403 (details) Channel/supergroup whose photo should be edited New photo Check if a username is free and can be assigned to a channel/supergroup See Possible codes: 400 (details) The channel/supergroup that will assigned the specified username The username to check Change or remove the username of a supergroup/channel See Possible codes: 400,403 (details) Channel New username, pass an empty string to remove the username Join a channel/supergroup See Possible codes: 400,406 (details) Channel/supergroup to join Leave a channel/supergroup See [bots: ✓] Possible codes: 400,403,406 (details) Channel/supergroup to leave Invite users to a channel/supergroup See Possible codes: 400,403,406 (details) Channel/supergroup Users to invite Delete a channel/supergroup See Possible codes: 400,403,406 (details) Channel/supergroup to delete Get link and embed info of a message in a channel/supergroup See Possible codes: 400 (details) Whether to include other grouped media (for albums) Whether to also include a thread ID, if available, inside of the link Channel Message ID Enable/disable message signatures in channels See Possible codes: 400 (details) If set, enables message signatures. If set, messages from channel admins will link to their profiles, just like for group messages: can only be set if the signatures_enabled flag is set. Channel Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups. See Possible codes: 400 (details) Get geogroups If set and the user has reached the limit of owned public channels/supergroups/geogroups, instead of returning the channel list one of the specified errors will be returned.
Useful to check if a new public channel can indeed be created, even before asking the user to enter a channel username to use in Channels_CheckUsername/Channels_UpdateUsername. Set this flag to only fetch the full list of channels that may be passed to Account_UpdatePersonalChannel to display them on our profile page. Ban/unban/kick a user in a supergroup/channel. See [bots: ✓] Possible codes: 400,403,406 (details) The supergroup/channel. Participant to ban The banned rights Get the admin log of a channel/supergroup See Possible codes: 400,403,406 (details) Channel Search query, can be empty Event filter Only show events from these admins Maximum ID of message to return (see pagination) Minimum ID of message to return (see pagination) Maximum number of results to return, see pagination Associate a stickerset to the supergroup See [bots: ✓] Possible codes: 400,406 (details) Supergroup The stickerset to associate Mark channel/supergroup message contents as read See Possible codes: 400,406 (details) Channel/supergroup IDs of messages whose contents should be marked as read Delete the history of a supergroup See Possible codes: 400 (details) Whether the history should be deleted for everyone Supergroup whose history must be deleted ID of message up to which the history must be deleted Hide/unhide message history for new channel/supergroup users See Possible codes: 400 (details) Channel/supergroup Hide/unhide Get a list of channels/supergroups we left, requires a takeout session, see here » for more info. See Possible codes: 403 (details) Offset for pagination Get all groups that can be used as discussion groups. See Associate a group to a channel as discussion group for that channel See Possible codes: 400,403 (details) Channel Discussion group to associate to the channel Transfer channel ownership See Possible codes: 400,403 (details) Channel New channel owner 2FA password of account Edit location of geogroup, see here » for more info on geogroups. See Possible codes: 400 (details) Geogroup New geolocation Address string Toggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds See Possible codes: 400 (details) The supergroup Users will only be able to send one message every seconds seconds, 0 to disable the limitation Get inactive channels and supergroups See Convert a supergroup to a gigagroup, when requested by channel suggestions. See Possible codes: 400,403 (details) The supergroup to convert Obtains a list of peers that can be used to send messages in a specific group See Possible codes: 400 (details) The group where we intend to send messages Delete all messages sent by a specific participant of a given supergroup See Possible codes: 400,403 (details) Supergroup The participant whose messages should be deleted Set whether all users should join a discussion group in order to comment on a post » See Possible codes: 400 (details) Discussion group Toggle Set whether all users should request admin approval to join the group ». See Possible codes: 400 (details) Group Toggle Reorder active usernames See Possible codes: 400 (details) The supergroup or channel The new order for active usernames. All active usernames must be specified. Activate or deactivate a purchased fragment.com username associated to a supergroup or channel we own. See Possible codes: 400 (details) Supergroup or channel Username Whether to activate or deactivate the username Disable all purchased usernames of a supergroup or channel See Possible codes: 400 (details) Supergroup or channel Enable or disable forum functionality in a supergroup. See Possible codes: 400 (details) Supergroup ID Enable or disable forum functionality Create a forum topic; requires manage_topics rights. See [bots: ✓] Possible codes: 400,403 (details) The forum Topic title (maximum UTF-8 length: 128) If no custom emoji icon is specified, specifies the color of the fallback topic icon (RGB), one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F. ID of the custom emoji used as topic icon. Telegram Premium users can use any custom emoji, other users can only use the custom emojis contained in the emoji pack. Unique client message ID to prevent duplicate sending of the same event You can use Create the topic as the specified peer Get topics of a forum See Possible codes: 400 (details) Supergroup Search query Offsets for pagination, for more info click here, date of the last message of the last found topic. Use 0 or any date in the future to get results from the last topic. Offsets for pagination, for more info click here, ID of the last message of the last found topic (or initially 0). Offsets for pagination, for more info click here, ID of the last found topic (or initially 0). Maximum number of results to return, see pagination. For optimal performance, the number of returned topics is chosen by the server and can be smaller than the specified limit. Get forum topics by their ID See Possible codes: 400 (details) Forum Topic IDs Edit forum topic; requires manage_topics rights. See [bots: ✓] Possible codes: 400,403 (details) Supergroup Topic ID If present, will update the topic title (maximum UTF-8 length: 128). If present, updates the custom emoji used as topic icon. Telegram Premium users can use any custom emoji, other users can only use the custom emojis contained in the emoji pack. Pass 0 to switch to the fallback topic icon. If present, will update the open/closed status of the topic. If present, will hide/unhide the topic (only valid for the "General" topic, id=1). Pin or unpin forum topics See Possible codes: 400 (details) Supergroup ID Forum topic ID Whether to pin or unpin the topic Delete message history of a forum topic See [bots: ✓] Possible codes: 400 (details) Forum Topic ID Reorder pinned forum topics See Possible codes: 400 (details) If not set, the order of only the topics present both server-side and in order will be changed (i.e. mentioning topics not pinned server-side in order will not pin them, and not mentioning topics pinned server-side will not unpin them).
If set, the entire server-side pinned topic list will be replaced with order (i.e. mentioning topics not pinned server-side in order will pin them, and not mentioning topics pinned server-side will unpin them) Supergroup ID Topic IDs » Enable or disable the native antispam system. See Possible codes: 400 (details) Supergroup ID. The specified supergroup must have at least telegram_antispam_group_size_min members to enable antispam functionality, as specified by the client configuration parameters. Enable or disable the native antispam system. Report a native antispam false positive See Possible codes: 400 (details) Supergroup ID Message ID that was mistakenly deleted by the native antispam system, taken from the admin log Hide or display the participants list in a supergroup. See Possible codes: 400 (details) Supergroup ID If true, will hide the participants list; otherwise will unhide it. Update the accent color and background custom emoji » of a channel. See Possible codes: 400 (details) Whether to change the accent color emoji pattern of the profile page; otherwise, the accent color and emoji pattern of messages will be changed.
Channels can change both message and profile palettes; supergroups can only change the profile palette, of course after reaching the appropriate boost level. Channel whose accent color should be changed. ID of the accent color palette » to use (not RGB24, see here » for more info); if not set, the default palette is used. Custom emoji ID used in the accent color pattern. Users may also choose to display messages from all topics of a forum as if they were sent to a normal group, using a "View as messages" setting in the local client: this setting only affects the current account, and is synced to other logged in sessions using this method. See Possible codes: 400 (details) The forum The new value of the view_forum_as_messages flag. Obtain a list of similarly themed public channels, selected based on similarities in their subscriber bases. See Possible codes: 400 (details) The method will return channels related to the passed channel. If not set, the method will returns channels related to channels the user has joined. Set an emoji status for a channel or supergroup. See Possible codes: 400 (details) The channel/supergroup, must have at least channel_emoji_status_level_min/group_emoji_status_level_min boosts. Emoji status to set Admins with ban_users admin rights » may allow users that apply a certain number of booosts » to the group to bypass Channels_ToggleSlowMode and other » supergroup restrictions, see here » for more info. See Possible codes: 400 (details) The supergroup. The number of required boosts (1-8, 0 to disable). Set a custom emoji stickerset for supergroups. Only usable after reaching at least the boost level » specified in the group_emoji_stickers_level_min » config parameter. See Possible codes: 400 (details) The supergroup The custom emoji stickerset to associate to the supergroup Disable ads on the specified channel, for all users. See Possible codes: 400 (details) The channel. Whether to disable or re-enable ads. Globally search for posts from public channels » (including those we aren't a member of) containing a specific hashtag. See The hashtag to search, without the # character. Initially 0, then set to the next_rate parameter of messages.messagesSlice Offsets for pagination, for more info click here Offsets for pagination, for more info click here Maximum number of results to return, see pagination Sends a custom request; for bots only See [bots: ✓] Possible codes: 400,403 (details) The method name JSON-serialized method parameters Answers a custom query; for bots only See [bots: ✓] Possible codes: 400,403 (details) Identifier of a custom query JSON-serialized answer to the query Set bot command list See [bots: ✓] Possible codes: 400 (details) Command scope Language code Bot commands Clear bot commands for the specified bot scope and language code See [bots: ✓] Possible codes: 400 (details) Command scope Language code Obtain a list of bot commands for the specified bot scope and language code See [bots: ✓] Possible codes: 400 (details) Command scope Language code Sets the menu button action » for a given user or for all users See [bots: ✓] Possible codes: 400 (details) User ID Bot menu button action Gets the menu button action for a given user or for all users, previously set using Bots_SetBotMenuButton; users can see this information in the . See [bots: ✓] Possible codes: 400 (details) User ID or empty for the default menu button. a null value means botMenuButtonDefault Set the default suggested admin rights for bots being added as admins to channels, see here for more info on how to handle them ». See [bots: ✓] Possible codes: 400 (details) Admin rights Set the default suggested admin rights for bots being added as admins to groups, see here for more info on how to handle them ». See [bots: ✓] Possible codes: 400 (details) Admin rights Set localized name, about text and description of a bot (or of the current account, if called by a bot). See [bots: ✓] Possible codes: 400 (details) If called by a user, must contain the peer of a bot we own. Language code, if left empty update the fallback about text and description New bot name New about text New description Get localized name, about text and description of a bot (or of the current account, if called by a bot). See [bots: ✓] Possible codes: 400 (details) If called by a user, must contain the peer of a bot we own. Language code, if left empty this method will return the fallback about text and description. Reorder usernames associated to a bot we own. See Possible codes: 400 (details) The bot The new order for active usernames. All active usernames must be specified. Activate or deactivate a purchased fragment.com username associated to a bot we own. See Possible codes: 400 (details) The bot Username Whether to activate or deactivate it Check whether the specified bot can send us messages See Possible codes: 400 (details) The bot Allow the specified bot to send us messages See Possible codes: 400 (details) The bot Send a custom request from a mini bot app, triggered by a web_app_invoke_custom_method event ». See Possible codes: 400 (details) Identifier of the bot associated to the mini bot app Identifier of the custom method to invoke Method parameters Fetch popular Main Mini Apps, to be used in the apps tab of global search ». See Offset for pagination, initially an empty string, then re-use the next_offset returned by the previous query. Maximum number of results to return, see pagination Add a main mini app preview, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. ISO 639-1 language code, indicating the localization of the preview to add. The photo/video preview, uploaded using Messages_UploadMedia. Edit a main mini app preview, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. ISO 639-1 language code, indicating the localization of the preview to edit. The photo/video preview to replace, previously fetched as specified here ». The new photo/video preview, uploaded using Messages_UploadMedia. Delete a main mini app preview, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. ISO 639-1 language code, indicating the localization of the preview to delete. The photo/video preview to delete, previously fetched as specified here ». Reorder a main mini app previews, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. ISO 639-1 language code, indicating the localization of the previews to reorder. New order of the previews. Bot owners only, fetch main mini app preview information, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. Fetch previews for the specified ISO 639-1 language code. Fetch main mini app previews, see here » for more info. See Possible codes: 400 (details) The bot that owns the Main Mini App. See See See See See Get a payment form See Possible codes: 400 (details) Invoice A JSON object with the following keys, containing color theme information (integers, RGB24) to pass to the payment provider, to apply in eventual verification pages:
bg_color - Background color
text_color - Text color
hint_color - Hint text color
link_color - Link color
button_color - Button color
button_text_color - Button text color Get payment receipt See Possible codes: 400 (details) The peer where the payment receipt was sent Message ID of receipt Submit requested order information for validation See Possible codes: 400 (details) Save order information to re-use it for future orders Invoice Requested order information Send compiled payment form See Possible codes: 400 (details) Form ID Invoice ID of saved and validated order info Chosen shipping option ID Payment credentials Tip, in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Get saved payment information See Clear saved payment information See Remove saved payment credentials Clear the last order settings saved by the user Get info about a credit card See Possible codes: 400 (details) Credit card number Generate an invoice deep link See [bots: ✓] Possible codes: 400 (details) Invoice Informs server about a purchase made through the App Store: for official applications only. See Possible codes: 400 (details) Receipt Payment purpose Informs server about a purchase made through the Play Store: for official applications only. See Possible codes: 400 (details) Receipt Payment purpose Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase, official apps only. See Possible codes: 406 (details) Payment purpose Obtain a list of Telegram Premium giveaway/gift code » options. See The channel that will start the giveaway Obtain information about a Telegram Premium giftcode » See Possible codes: 400 (details) The giftcode to check Apply a Telegram Premium giftcode » See Possible codes: 400,420 (details) The code to apply Obtain information about a Telegram Premium giveaway ». See Possible codes: 400 (details) The peer where the giveaway was posted. Message ID of the service message Launch a prepaid giveaway ». See Possible codes: 400 (details) The peer where to launch the giveaway. The prepaid giveaway ID. Giveway parameters Obtain a list of Telegram Stars topup options » as s. See Get the current Telegram Stars balance of the current account (with peer=), or the stars balance of the bot specified in peer. See Possible codes: 400 (details) Peer of which to get the balance. Fetch Telegram Stars transactions. See [bots: ✓] Possible codes: 400 (details) If set, fetches only incoming transactions. If set, fetches only outgoing transactions. Return transactions in ascending order by date (instead of descending order by date). If set, fetches only transactions for the specified Telegram Star subscription ». Fetch the transaction history of the peer ( or a bot we own). Offset for pagination, obtained from the returned next_offset, initially an empty string ». Maximum number of results to return, see pagination Make a payment using Telegram Stars, see here » for more info. See Possible codes: 400 (details) Payment form ID Invoice Refund a Telegram Stars transaction, see here » for more info. See [bots: ✓] Possible codes: 400 (details) User to refund. Transaction ID. Get Telegram Star revenue statistics ». See Possible codes: 400 (details) Whether to enable dark theme for graph colors Get statistics for the specified bot, channel or ourselves (). Withdraw funds from a channel or bot's star balance ». See Possible codes: 400 (details) Channel or bot from which to withdraw funds. Amount of stars to withdraw. 2FA password, see here » for more info. Returns a URL for a Telegram Ad platform account that can be used to set up advertisements for channel/bot in peer, paid using the Telegram Stars owned by the specified peer, see here » for more info. See Possible codes: 400 (details) Channel or bot that owns the stars. Obtain info about Telegram Star transactions » using specific transaction IDs. See Possible codes: 400 (details) Channel or bot. Transaction IDs. Obtain a list of Telegram Stars gift options » as s. See Receiver of the gift (optional). Obtain a list of active, expired or cancelled Telegram Star subscriptions ». See [bots: ✓] Whether to return only expired subscriptions due to an excessively low Telegram Star balance. Always pass . Offset for pagination, taken from payments.starsStatus. Activate or deactivate a Telegram Star subscription ». See [bots: ✓] Always pass . ID of the subscription. Whether to cancel or reactivate the subscription. Re-join a private channel associated to an active Telegram Star subscription ». See [bots: ✓] Always pass . ID of the subscription. Fetch a list of star giveaway options ». See [bots: ✓] Get a list of available gifts, see here » for more info. See [bots: ✓] Hash used for caching, for more info click here. a null value means payments.starGiftsNotModified Get the gifts » pinned on a specific user's profile. See [bots: ✓] Identifier of the user (can be the current user to fetch all gifts received by the current user). Offset for pagination, taken from (initially empty). Maximum number of results to return, see pagination Display or remove a received gift » from our profile. See [bots: ✓] If set, hides the gift from our profile. ID of the user that sent us the gift. The ID of the with the . Convert a received gift » into Telegram Stars: this will permanently destroy the gift, converting it into .convert_stars Telegram Stars, added to the user's balance. See [bots: ✓] ID of the user that sent us the gift. The ID of the with the . See See See See See See Create a stickerset. See [bots: ✓] Possible codes: 400 (details) Whether this is a mask stickerset Whether this is a custom emoji stickerset. Whether the color of TGS custom emojis contained in this set should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context. For custom emoji stickersets only. Stickerset owner Stickerset name, 1-64 chars Short name of sticker set, to be used in sticker deep links ». Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and, if called by a bot, must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters. Thumbnail Stickers Used when importing stickers using the sticker import SDKs, specifies the name of the software that created the stickers a null value means messages.stickerSetNotModified Remove a sticker from the set where it belongs. The sticker set must have been created by the current user/bot. See [bots: ✓] Possible codes: 400 (details) The sticker to remove a null value means messages.stickerSetNotModified Changes the absolute position of a sticker in the set to which it belongs. The sticker set must have been created by the current user/bot. See [bots: ✓] Possible codes: 400 (details) The sticker The new position of the sticker, zero-based a null value means messages.stickerSetNotModified Add a sticker to a stickerset. The sticker set must have been created by the current user/bot. See [bots: ✓] Possible codes: 400,406 (details) The stickerset The sticker a null value means messages.stickerSetNotModified Set stickerset thumbnail See [bots: ✓] Possible codes: 400 (details) Stickerset Thumbnail (only for normal stickersets, not custom emoji stickersets). Only for custom emoji stickersets, ID of a custom emoji present in the set to use as thumbnail; pass 0 to fallback to the first custom emoji of the set. a null value means messages.stickerSetNotModified Check whether the given short name is available See Possible codes: 400 (details) Short name Suggests a short name for a given stickerpack name See Possible codes: 400 (details) Sticker pack name Update the keywords, emojis or mask coordinates of a sticker. See [bots: ✓] Possible codes: 400 (details) The sticker If set, updates the emoji list associated to the sticker If set, updates the mask coordinates If set, updates the sticker keywords (separated by commas). Can't be provided for mask stickers. a null value means messages.stickerSetNotModified Renames a stickerset. See [bots: ✓] Possible codes: 400 (details) Stickerset to rename New stickerset title a null value means messages.stickerSetNotModified Deletes a stickerset we created. See [bots: ✓] Possible codes: 400 (details) Stickerset to delete Replace a sticker in a stickerset ». See [bots: ✓] Possible codes: 400 (details) Old sticker document. New sticker. a null value means messages.stickerSetNotModified Get phone call configuration to be passed to libtgvoip's shared config See Start a telegram phone call See Possible codes: 400,403 (details) Whether to start a video call Destination of the phone call Random ID to avoid resending the same object Parameter for E2E encryption key exchange » Phone call settings Accept incoming call See Possible codes: 400,406,500 (details) The call to accept Parameter for E2E encryption key exchange » Phone call settings Complete phone call E2E encryption key exchange » See Possible codes: 400 (details) The phone call Parameter for E2E encryption key exchange » Key fingerprint Phone call settings Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended. See Possible codes: 400 (details) The phone call we're currently in Refuse or end running call See Possible codes: 400,500 (details) Whether this is a video call The phone call Call duration Why was the call discarded Preferred libtgvoip relay ID Rate a call, returns info about the rating message sent to the official VoIP bot. See Possible codes: 400 (details) Whether the user decided on their own initiative to rate the call The call to rate Rating in 1-5 stars An additional comment Send phone call debug data to server See Possible codes: 400 (details) Phone call Debug statistics obtained from libtgvoip Send VoIP signaling data See Possible codes: 400 (details) Phone call Signaling payload Create a group call or livestream See Possible codes: 400 (details) Whether RTMP stream support should be enabled: only the group/supergroup/channel owner can use this flag. Associate the group call or livestream to the provided group/supergroup/channel Unique client message ID required to prevent creation of duplicate group calls Call title For scheduled group call or livestreams, the absolute date when the group call will start Join a group call See Possible codes: 400,403 (details) If set, the user will be muted by default upon joining. If set, the user's video will be disabled by default upon joining. The group call Join the group call, presenting yourself as the specified user/channel The invitation hash from the invite link », if provided allows speaking in a livestream or muted group chat. WebRTC parameters Leave a group call See Possible codes: 400 (details) The group call Your source ID Invite a set of users to a group call. See Possible codes: 400,403 (details) The group call The users to invite. Terminate a group call See Possible codes: 400,403 (details) The group call to terminate Change group call settings See Possible codes: 400 (details) Invalidate existing invite links Group call Whether all users will that join this group call are muted by default upon joining the group call Get info about a group call See Possible codes: 400,403 (details) The group call Maximum number of results to return, see pagination Get group call participants See Possible codes: 400 (details) Group call If specified, will fetch group participant info about the specified peers If specified, will fetch group participant info about the specified WebRTC source IDs Offset for results, taken from the next_offset field of , initially an empty string.
Note: if no more results are available, the method call will return an empty next_offset; thus, avoid providing the next_offset returned in if it is empty, to avoid an infinite loop. Maximum number of results to return, see pagination Check whether the group call Server Forwarding Unit is currently receiving the streams with the specified WebRTC source IDs.
Returns an intersection of the source IDs specified in sources, and the source IDs currently being forwarded by the SFU. See Possible codes: 400 (details) Group call Source IDs Start or stop recording a group call: the recorded audio and video streams will be automatically sent to Saved messages (the chat with ourselves). See Possible codes: 400,403 (details) Whether to start or stop recording Whether to also record video streams The group call or livestream Recording title If video stream recording is enabled, whether to record in portrait or landscape mode Edit information about a given group call participant See Possible codes: 400,403 (details) The group call The group call participant (can also be the user itself) Whether to mute or unmute the specified participant New volume Raise or lower hand Start or stop the video stream Pause or resume the video stream Pause or resume the screen sharing stream Edit the title of a group call or livestream See Possible codes: 400,403 (details) Group call New title Get a list of peers that can be used to join a group call, presenting yourself as a specific user/channel. See Possible codes: 400 (details) The dialog whose group call or livestream we're trying to join Get an invite link for a group call or livestream See Possible codes: 400,403 (details) For livestreams or muted group chats, if set, users that join using this link will be able to speak without explicitly requesting permission by (for example by raising their hand). The group call Subscribe or unsubscribe to a scheduled group call See Possible codes: 400,403 (details) Scheduled group call Enable or disable subscription Start a scheduled group call. See Possible codes: 400,403 (details) The scheduled group call Set the default peer that will be used to join a group call in a specific dialog. See Possible codes: 400 (details) The dialog The default peer that will be used to join group calls in this dialog, presenting yourself as a specific user/channel. Start screen sharing in a call See Possible codes: 400,403 (details) The group call WebRTC parameters Stop screen sharing in a group call See Possible codes: 400 (details) The group call Get info about RTMP streams in a group call or livestream.
This method should be invoked to the same group/channel-related DC used for downloading livestream chunks.
As usual, the media DC is preferred, if available. See Possible codes: 400 (details) Group call or livestream Get RTMP URL and stream key for RTMP livestreams. Can be used even before creating the actual RTMP livestream with Phone_CreateGroupCall (the rtmp_stream flag must be set). See Possible codes: 400 (details) Peer to livestream into Whether to revoke the previous stream key or simply return the existing one Save phone call debug information See Possible codes: 400 (details) Phone call Logs Get localization pack strings See Possible codes: 400 (details) Platform identifier (i.e. android, tdesktop, etc). Either an ISO 639-1 language code or a language pack name obtained from a language pack link. Get strings from a language pack See Possible codes: 400 (details) Platform identifier (i.e. android, tdesktop, etc). Either an ISO 639-1 language code or a language pack name obtained from a language pack link. Strings to get Get new strings in language pack See Possible codes: 400 (details) Platform identifier (i.e. android, tdesktop, etc). Either an ISO 639-1 language code or a language pack name obtained from a language pack link. Previous localization pack version Get information about all languages in a localization pack See Possible codes: 400 (details) Platform identifier (i.e. android, tdesktop, etc). Get information about a language in a localization pack See Possible codes: 400 (details) Platform identifier (i.e. android, tdesktop, etc). Either an ISO 639-1 language code or a language pack name obtained from a language pack link. Edit peers in peer folder See Possible codes: 400 (details) New peer list Get channel statistics See Possible codes: 400,403 (details) Whether to enable dark theme for graph colors The channel Load channel statistics graph asynchronously See Possible codes: 400 (details) Graph token from Zoom value, if required Get supergroup statistics See Possible codes: 400,403 (details) Whether to enable dark theme for graph colors Supergroup ID Obtains a list of messages, indicating to which other public channels was a channel message forwarded.
Will return a list of messages with peer_id equal to the public channel to which this message was forwarded. See Possible codes: 400 (details) Source channel Source message ID Offset for pagination, empty string on first call, then use the next_offset field of the returned constructor (if present, otherwise no more results are available). Maximum number of results to return, see pagination Get message statistics See Possible codes: 400 (details) Whether to enable dark theme for graph colors Channel ID Message ID Get statistics for a certain story. See Possible codes: 400 (details) Whether to enable the dark theme for graph colors The peer that posted the story Story ID Obtain forwards of a story as a message to public chats and reposts by public channels. See Possible codes: 400 (details) Peer where the story was originally posted Story ID Offset for pagination, from .next_offset. Maximum number of results to return, see pagination Get channel ad revenue statistics ». See Possible codes: 400 (details) Whether to enable dark theme for graph colors Get ad revenue stats for the specified channel or bot Withdraw funds from a channel's ad revenue balance ». See Possible codes: 400 (details) Get ad revenue withdrawal URL for the specified channel or bot 2FA password, see here » for more info. Fetch channel ad revenue transaction history ». See Possible codes: 400 (details) Get ad revenue transactions for the specified channel or bot Offset for pagination Maximum number of results to return, see pagination Export a folder », creating a chat folder deep link ». See Possible codes: 400 (details) The folder to export An optional name for the link The list of channels, group and supergroups to share with the link. Basic groups will automatically be converted to supergroups when invoking the method. Delete a previously created chat folder deep link ». See Possible codes: 400 (details) The related folder slug obtained from the chat folder deep link ». Edit a chat folder deep link ». See Possible codes: 400 (details) Folder ID slug obtained from the chat folder deep link ». If set, sets a new name for the link If set, changes the list of peers shared with the link List all chat folder deep links » associated to a folder See Possible codes: 400 (details) The folder Obtain information about a chat folder deep link ». See Possible codes: 400 (details) slug obtained from the chat folder deep link » Import a chat folder deep link », joining some or all the chats in the folder. See Possible codes: 400 (details) slug obtained from a chat folder deep link ». List of new chats to join, fetched using Chatlists_CheckChatlistInvite and filtered as specified in the documentation ». Fetch new chats associated with an imported chat folder deep link ». Must be invoked at most every chatlist_update_period seconds (as per the related client configuration parameter »). See Possible codes: 400 (details) The folder Join channels and supergroups recently added to a chat folder deep link ». See Possible codes: 400 (details) The folder List of new chats to join, fetched using Chatlists_GetChatlistUpdates and filtered as specified in the documentation ». Dismiss new pending peers recently added to a chat folder deep link ». See Possible codes: 400 (details) The folder Returns identifiers of pinned or always included chats from a chat folder imported using a chat folder deep link », which are suggested to be left when the chat folder is deleted. See Possible codes: 400 (details) Folder ID Delete a folder imported using a chat folder deep link » See Possible codes: 400 (details) Folder ID Also leave the specified channels and groups Check whether we can post stories as the specified peer. See Possible codes: 400 (details) The peer from which we wish to post stories. Uploads a Telegram Story. See Possible codes: 400 (details) Whether to add the story to the profile automatically upon expiration. If not set, the story will only be added to the archive, see here » for more info. If set, disables forwards, screenshots, and downloads. Set this flag when reposting stories with fwd_from_id+fwd_from_id, if the media was modified before reposting. The peer to send the story as. The story media. Media areas associated to the story, see here » for more info. Story caption. Message entities for styled text, if allowed by the stories_entities client configuration parameter ». Privacy rules for the story, indicating who can or can't view the story. Unique client message ID required to prevent message resending. You can use Period after which the story is moved to archive (and to the profile if pinned is set), in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise. If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id. If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id. Edit an uploaded story See Possible codes: 400 (details) Peer where the story was posted. ID of story to edit. If specified, replaces the story media. Media areas associated to the story, see here » for more info. If specified, replaces the story caption. Message entities for styled text in the caption, if allowed by the stories_entities client configuration parameter ». If specified, alters the privacy settings » of the story, changing who can or can't view the story. Deletes some posted stories. See Possible codes: 400 (details) Channel/user from where to delete stories. IDs of stories to delete. Pin or unpin one or more stories See Possible codes: 400 (details) Peer where to pin or unpin stories IDs of stories to pin or unpin Whether to pin or unpin the stories Fetch the List of active (or active and hidden) stories, see here » for more info on watching stories. See If next and state are both set, uses the passed state to paginate to the next results; if neither state nor next are set, fetches the initial page; if state is set and next is not set, check for changes in the active/hidden peerset, see here » for more info on the full flow. If set, fetches the hidden active story list, otherwise fetches the active story list, see here » for more info on the full flow. If next and state are both set, uses the passed state to paginate to the next results; if neither state nor next are set, fetches the initial page; if state is set and next is not set, check for changes in the active/hidden peerset, see here » for more info on the full flow. Fetch the stories pinned on a peer's profile. See Possible codes: 400 (details) Peer whose pinned stories should be fetched Offsets for pagination, for more info click here Maximum number of results to return, see pagination Fetch the story archive » of a peer we control. See Possible codes: 400 (details) Peer whose archived stories should be fetched Offsets for pagination, for more info click here Maximum number of results to return, see pagination Obtain full info about a set of stories by their IDs. See Possible codes: 400 (details) Peer where the stories were posted Story IDs Hide the active stories of a specific peer, preventing them from being displayed on the action bar on the homescreen. See Whether to hide or unhide all active stories of the peer Mark all stories up to a certain ID as read, for a given peer; will emit an update to all logged-in sessions. See Possible codes: 400 (details) The peer whose stories should be marked as read. Mark all stories up to and including this ID as read Increment the view counter of one or more stories. See Possible codes: 400 (details) Peer where the stories were posted. IDs of the stories (maximum 200 at a time). Obtain the list of users that have viewed a specific story we posted See Possible codes: 400 (details) Whether to only fetch view reaction/views made by our contacts Whether to return info about users that reacted to the story (i.e. if set, the server will first sort results by view date as usual, and then also additionally sort the list by putting s with an associated reaction first in the list). Ignored if forwards_first is set. If set, returns forwards and reposts first, then reactions, then other views; otherwise returns interactions sorted just by interaction date. Peer where the story was posted Search for specific peers Story ID Offset for pagination, obtained from .next_offset Maximum number of results to return, see pagination Obtain info about the view count, forward count, reactions and recent viewers of one or more stories. See Possible codes: 400 (details) Peer whose stories should be fetched Story IDs Generate a story deep link for a specific story See Possible codes: 400 (details) Peer where the story was posted Story ID Report a story. See Possible codes: 400 (details) The peer that uploaded the story. IDs of the stories to report. Menu option, intially empty Comment for report moderation Activates stories stealth mode, see here » for more info. See Possible codes: 400 (details) Whether to erase views from any stories opened in the past stories_stealth_past_period seconds », as specified by the client configuration. Whether to hide future story views for the next stories_stealth_future_period seconds », as specified by the client configuration. React to a story. See Possible codes: 400 (details) Whether to add this reaction to the recent reactions list ». The peer that sent the story ID of the story to react to Reaction Fetch the full active story list of a specific peer. See Possible codes: 400 (details) Peer whose stories should be fetched Obtain the latest read story ID for all peers when first logging in, returned as a list of updates, see here » for more info. See Get the IDs of the maximum read stories for a set of peers. See Peers Obtain a list of channels where the user can post stories See Hide the active stories of a user, preventing them from being displayed on the action bar on the homescreen, see here » for more info. See Possible codes: 400 (details) Peer whose stories should be (un)hidden. Whether to hide or unhide stories. Get the reaction and interaction list of a story posted to a channel, along with the sender of each reaction. See Possible codes: 400 (details) If set, returns forwards and reposts first, then reactions, then other views; otherwise returns interactions sorted just by interaction date. Channel Story ID Get only reactions of this type Offset for pagination (taken from the next_offset field of the returned ); empty in the first request. Maximum number of results to return, see pagination Pin some stories to the top of the profile, see here » for more info. See Possible codes: 400 (details) Peer where to pin stories. IDs of the stories to pin (max stories_pinned_to_top_count_max). Globally search for stories using a hashtag or a location media area, see here » for more info on the full flow. See Possible codes: 400 (details) Hashtag (without the #) A or a .
Note areas may be searched only if they have an associated address. If set, returns only stories posted by this peer. Offset for pagination: initially an empty string, then the next_offset from the previously returned . Maximum number of results to return, see pagination Obtains info about the boosts that were applied to a certain channel or supergroup (admins only) See Possible codes: 400 (details) Whether to return only info about boosts received from gift codes and giveaways created by the channel/supergroup » The channel/supergroup Offset for pagination, obtained from .next_offset Maximum number of results to return, see pagination Obtain which peers are we currently boosting, and how many boost slots we have left. See Apply one or more boosts » to a peer. See Possible codes: 400 (details) Which boost slots to assign to this peer. The peer to boost. Gets the current number of boosts of a channel/supergroup. See Possible codes: 400 (details) The peer. Returns the lists of boost that were applied to a channel/supergroup by a specific user (admins only) See [bots: ✓] Possible codes: 400 (details) The channel/supergroup The user Check if we can process SMS jobs (official clients only). See Possible codes: 403 (details) Enable SMS jobs (official clients only). See Possible codes: 400 (details) Disable SMS jobs (official clients only). See Possible codes: 400 (details) Update SMS job settings (official clients only). See Possible codes: 400 (details) Allow international numbers? Get SMS jobs status (official clients only). See Possible codes: 400 (details) Get info about an SMS job (official clients only). See Possible codes: 400 (details) Job ID Finish an SMS job (official clients only). See Possible codes: 400 (details) Job ID. If failed, the error. Fetch information about a fragment collectible, see here » for more info on the full flow. See Possible codes: 400 (details) Collectible to fetch info about. Object describes the contents of an encrypted message. See Flags, see TL conditional fields (added in layer 45) Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Message entities for styled text (parameter added in layer 45) Specifies the ID of the inline bot that generated the message (parameter added in layer 45) Random message ID of the message this message replies to (parameter added in layer 45) Random group ID, assigned by the author of message.
Multiple encrypted messages with a photo attached and with the same group ID indicate an album or grouped media (parameter added in layer 45) Object describes media contents of an encrypted message. See a value means decryptedMessageMediaEmpty Object describes the action to which a service message is linked. See Indicates the location of a photo, will be deprecated soon See Server volume File ID Checksum to access the file Contents of an encrypted message. See Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message text Media content Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message text Media content Contents of an encrypted service message. See Random message ID, assigned by the message author.
Must be equal to the ID passed to the sending method. Action relevant to the service message Random message ID, assigned by the message author.
Must be equal to the ID passed to the sending method. Action relevant to the service message Photo attached to an encrypted message. See Content of thumbnail file (JPEGfile, quality 55, set in a square 90x90) Thumbnail width Thumbnail height Photo width Photo height Size of the photo in bytes Key to decrypt an attached file with a full version Initialization vector Video attached to an encrypted message. See Content of thumbnail file (JPEG file, quality 55, set in a square 90x90) Thumbnail width Thumbnail height Duration of video in seconds Image width Image height File size Key to decrypt the attached video file Initialization vector GeoPoint attached to an encrypted message. See Latitude of point Longitude of point Contact attached to an encrypted message. See Phone number Contact's first name Contact's last name Telegram User ID of signed-up contact Document attached to a message in a secret chat. See Thumbnail-file contents (JPEG-file, quality 55, set in a 90x90 square) Thumbnail width Thumbnail height File MIME-type Document size ( on layer <143, on layer >=143) Key to decrypt the attached document file Initialization File MIME-type Audio file attached to a secret chat message. See Audio duration in seconds File size Key to decrypt the attached media file Initialization vector Setting of a message lifetime after reading. See Lifetime in seconds Messages marked as read. See List of message IDs Deleted messages. See List of deleted message IDs A screenshot was taken. See List of affected message ids (that appeared on the screenshot) The entire message history has been deleted. See Image description. See Thumbnail type » Image width Image height File size Thumbnail type » Description of an image and its content. See Thumbnail type Image width Image height Binary data, file content Thumbnail type User is uploading a video. See User is uploading a voice message. See User is uploading a photo. See User is uploading a file. See Defines a sticker See Defines a video See Duration in seconds Video width Video height Represents an audio file See Duration in seconds Contents of an encrypted message. See Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Contents of an encrypted service message. See Random message ID, assigned by the message author.
Must be equal to the ID passed to the sending method. Action relevant to the service message Random message ID, assigned by the message author.
Must be equal to the ID passed to the sending method. Action relevant to the service message Video attached to an encrypted message. See Content of thumbnail file (JPEG file, quality 55, set in a square 90x90) Thumbnail width Thumbnail height Duration of video in seconds MIME-type of the video file
Parameter added in Layer 17. Image width Image height File size Key to decrypt the attached video file Initialization vector MIME-type of the video file
Parameter added in Layer 17. Audio file attached to a secret chat message. See Audio duration in seconds MIME-type of the audio file
Parameter added in Layer 13. File size Key to decrypt the attached media file Initialization vector MIME-type of the audio file
Parameter added in Layer 13. Non-e2e documented forwarded from non-secret chat See Document ID access hash Date Mime type Size Thumbnail DC ID Attributes for media types Mime type Request for the other party in a Secret Chat to automatically resend a contiguous range of previously sent messages, as explained in Sequence number is Secret Chats. See out_seq_no of the first message to be resent, with correct parity out_seq_no of the last message to be resent, with same parity. A notification stating the API layer that is used by the client. You should use your current layer and take notice of the layer used on the other side of a conversation when sending messages. See Layer number, must be 17 or higher (this constructor was introduced in Layer 17. User is preparing a message: typing, recording, uploading, etc. See Type of action Request rekeying, see rekeying process See Exchange ID g_a, see rekeying process Accept new key See Exchange ID B parameter, see rekeying process Key fingerprint, see rekeying process Abort rekeying See Exchange ID Commit new key, see rekeying process See Exchange ID, see rekeying process Key fingerprint, see rekeying process NOOP action See Sets the layer number for the contents of an encrypted message. See Set of random bytes to prevent content recognition in short encrypted messages.
Clients are required to check that there are at least 15 random bytes included in each message. Messages with less than 15 random bytes must be ignored.
Parameter moved here from in Layer 17. Layer number. Mimimal value - 17 (the layer in which the constructor was added). 2x the number of messages in the sender's inbox (including deleted and service messages), incremented by 1 if current user was not the chat creator
Parameter added in Layer 17. 2x the number of messages in the recipient's inbox (including deleted and service messages), incremented by 1 if current user was the chat creator
Parameter added in Layer 17. The content of message itself File is currently unavailable. See Server volume File ID Checksum to access the file Server volume File ID Checksum to access the file File location. See Number of the data center holding the file Server volume File ID Checksum to access the file Server volume File ID Checksum to access the file Represents an audio file See Duration in seconds Name of song Performer Defines a sticker See Alternative emoji representation of sticker Associated stickerset Message entity representing a user mention: for creating a mention use . See Identifier of the user that was mentioned Contents of an encrypted message. See Extra bits of information, use flags.HasFlag(...) to test for those Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Message entities for styled text (parameter added in layer 45) Specifies the ID of the inline bot that generated the message (parameter added in layer 45) Random message ID of the message this message replies to (parameter added in layer 45) Field has a value Field has a value Field has a value Field has a value Flags, see TL conditional fields (added in layer 45) Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Message entities for styled text (parameter added in layer 45) Specifies the ID of the inline bot that generated the message (parameter added in layer 45) Random message ID of the message this message replies to (parameter added in layer 45) Photo attached to an encrypted message. See Content of thumbnail file (JPEGfile, quality 55, set in a square 90x90) Thumbnail width Thumbnail height Photo width Photo height Size of the photo in bytes Key to decrypt an attached file with a full version Initialization vector Caption Video attached to an encrypted message. See Content of thumbnail file (JPEG file, quality 55, set in a square 90x90) Thumbnail width Thumbnail height Duration of video in seconds MIME-type of the video file
Parameter added in Layer 17. Image width Image height File size Key to decrypt the attached video file Initialization vector Caption MIME-type of the video file
Parameter added in Layer 17. Document attached to a message in a secret chat. See Thumbnail-file contents (JPEG-file, quality 55, set in a 90x90 square) Thumbnail width Thumbnail height File MIME-type Document size ( on layer <143, on layer >=143) Key to decrypt the attached document file Initialization Document attributes for media types Caption File MIME-type Venue See Latitude of venue Longitude of venue Venue name Address Venue provider: currently only "foursquare" and "gplaces" (Google Places) need to be supported Venue ID in the provider's database Webpage preview See URL of webpage User is uploading a round video See Defines a video See Extra bits of information, use flags.HasFlag(...) to test for those Duration in seconds Video width Video height Whether this is a round video Contents of an encrypted message. See Extra bits of information, use flags.HasFlag(...) to test for those Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Message entities for styled text (parameter added in layer 45) Specifies the ID of the inline bot that generated the message (parameter added in layer 45) Random message ID of the message this message replies to (parameter added in layer 45) Random group ID, assigned by the author of message.
Multiple encrypted messages with a photo attached and with the same group ID indicate an album or grouped media (parameter added in layer 45) Field has a value Whether this is a silent message (no notification triggered) Field has a value Field has a value Field has a value Field has a value Flags, see TL conditional fields (added in layer 45) Random message ID, assigned by the author of message.
Must be equal to the ID passed to sending method. Message lifetime. Has higher priority than .
Parameter added in Layer 17. Message text Media content Message entities for styled text (parameter added in layer 45) Specifies the ID of the inline bot that generated the message (parameter added in layer 45) Random message ID of the message this message replies to (parameter added in layer 45) Random group ID, assigned by the author of message.
Multiple encrypted messages with a photo attached and with the same group ID indicate an album or grouped media (parameter added in layer 45) Message entity representing a block quote. See Document attached to a message in a secret chat. See Thumbnail-file contents (JPEG-file, quality 55, set in a 90x90 square) Thumbnail width Thumbnail height File MIME-type Document size ( on layer <143, on layer >=143) Key to decrypt the attached document file Initialization Document attributes for media types Caption File MIME-type Manager ensuring that you receive Telegram updates in correct order, without missing any Event to be called on sequential individual update Resume session by recovering all updates that occured since the state saved in this file Custom users/chats collector. By default, those are collected in properties Users/Chats if your method can be called again even when last async call didn't return yet Manager ensuring that you receive Telegram updates in correct order, without missing any Event to be called on sequential individual update (optional) Resume session by recovering all updates that occured since this state Custom users/chats collector. By default, those are collected in properties Users/Chats if your method can be called again even when last async call didn't return yet